blob: 534753ca12542383002cbf5544ac5027c02938cf [file] [log] [blame]
bellarde88de092005-02-07 12:35:39 +00001#ifndef QEMU_H
2#define QEMU_H
bellard31e31b82003-02-18 22:55:36 +00003
Timothy E Baldwin4d330ce2016-05-12 18:47:46 +01004#include "hostdep.h"
bellard6180a182003-09-30 21:04:53 +00005#include "cpu.h"
Paolo Bonzini63c91552016-03-15 13:18:37 +01006#include "exec/exec-all.h"
Paolo Bonzinif08b6172014-03-28 19:42:10 +01007#include "exec/cpu_ldst.h"
blueswir1992f48a2007-10-14 16:27:31 +00008
balrog06177d32007-12-24 13:47:52 +00009#undef DEBUG_REMAP
10#ifdef DEBUG_REMAP
balrog06177d32007-12-24 13:47:52 +000011#endif /* DEBUG_REMAP */
12
Paolo Bonzini022c62c2012-12-17 18:19:49 +010013#include "exec/user/abitypes.h"
blueswir1992f48a2007-10-14 16:27:31 +000014
Paolo Bonzini022c62c2012-12-17 18:19:49 +010015#include "exec/user/thunk.h"
blueswir1992f48a2007-10-14 16:27:31 +000016#include "syscall_defs.h"
Lluís Vilanova460c5792016-02-01 19:38:42 +010017#include "target_syscall.h"
Paolo Bonzini022c62c2012-12-17 18:19:49 +010018#include "exec/gdbstub.h"
bellard66fb9762003-03-23 01:06:05 +000019
Peter Maydell1d48fdd2016-06-14 12:49:18 +010020/* This is the size of the host kernel's sigset_t, needed where we make
21 * direct system calls that take a sigset_t pointer and a size.
22 */
23#define SIGSET_T_SIZE (_NSIG / 8)
24
bellard31e31b82003-02-18 22:55:36 +000025/* This struct is used to hold certain information about the image.
26 * Basically, it replicates in user space what would be certain
27 * task_struct fields in the kernel
28 */
29struct image_info {
Richard Henderson9955ffa2010-07-27 10:25:30 -070030 abi_ulong load_bias;
blueswir1992f48a2007-10-14 16:27:31 +000031 abi_ulong load_addr;
32 abi_ulong start_code;
33 abi_ulong end_code;
34 abi_ulong start_data;
35 abi_ulong end_data;
36 abi_ulong start_brk;
37 abi_ulong brk;
Richard Henderson6fd59442020-01-17 13:02:45 -100038 abi_ulong reserve_brk;
blueswir1992f48a2007-10-14 16:27:31 +000039 abi_ulong start_mmap;
blueswir1992f48a2007-10-14 16:27:31 +000040 abi_ulong start_stack;
Paul Brook97374d32010-06-16 13:03:51 +010041 abi_ulong stack_limit;
blueswir1992f48a2007-10-14 16:27:31 +000042 abi_ulong entry;
43 abi_ulong code_offset;
44 abi_ulong data_offset;
Mika Westerbergedf8e2a2009-04-07 09:57:11 +030045 abi_ulong saved_auxv;
Alexander Graf125b0f52012-01-28 21:12:14 +020046 abi_ulong auxv_len;
Mika Westerbergedf8e2a2009-04-07 09:57:11 +030047 abi_ulong arg_start;
48 abi_ulong arg_end;
Richard Henderson7c4ee5b2016-12-15 09:38:11 -080049 abi_ulong arg_strings;
50 abi_ulong env_strings;
51 abi_ulong file_string;
Paul Brookd8fd2952012-03-30 18:02:50 +010052 uint32_t elf_flags;
Paolo Bonzini7d374352018-12-13 23:37:37 +010053 int personality;
Laurent Vivier33143c42018-07-16 21:53:49 +020054 abi_ulong alignment;
Christophe Lyona99856c2018-04-30 10:03:41 +020055
56 /* The fields below are used in FDPIC mode. */
Mike Frysinger1af02e82011-02-07 01:05:50 -050057 abi_ulong loadmap_addr;
58 uint16_t nsegs;
59 void *loadsegs;
60 abi_ulong pt_dynamic_addr;
Christophe Lyon3cb10cf2018-04-30 10:03:43 +020061 abi_ulong interpreter_loadmap_addr;
62 abi_ulong interpreter_pt_dynamic_addr;
Mike Frysinger1af02e82011-02-07 01:05:50 -050063 struct image_info *other_info;
Richard Henderson83f990e2020-10-21 10:37:47 -070064
65 /* For target-specific processing of NT_GNU_PROPERTY_TYPE_0. */
66 uint32_t note_flags;
67
Stefan Markovic74cfc702018-10-22 16:43:40 +020068#ifdef TARGET_MIPS
69 int fp_abi;
70 int interp_fp_abi;
71#endif
bellard31e31b82003-02-18 22:55:36 +000072};
73
bellardb346ff42003-06-15 20:05:50 +000074#ifdef TARGET_I386
bellard851e67a2003-03-29 16:53:14 +000075/* Information about the current linux thread */
76struct vm86_saved_state {
77 uint32_t eax; /* return code */
78 uint32_t ebx;
79 uint32_t ecx;
80 uint32_t edx;
81 uint32_t esi;
82 uint32_t edi;
83 uint32_t ebp;
84 uint32_t esp;
85 uint32_t eflags;
86 uint32_t eip;
87 uint16_t cs, ss, ds, es, fs, gs;
88};
bellardb346ff42003-06-15 20:05:50 +000089#endif
bellard851e67a2003-03-29 16:53:14 +000090
Peter Maydell848d72c2013-09-03 20:12:17 +010091#if defined(TARGET_ARM) && defined(TARGET_ABI32)
bellard28c4f362004-02-16 21:47:43 +000092/* FPU emulator */
93#include "nwfpe/fpa11.h"
bellard28c4f362004-02-16 21:47:43 +000094#endif
95
pbrook624f7972008-05-31 16:11:38 +000096#define MAX_SIGQUEUE_SIZE 1024
97
pbrook624f7972008-05-31 16:11:38 +000098struct emulated_sigtable {
99 int pending; /* true if signal is pending */
Timothy E Baldwin907f5fd2016-05-27 15:51:52 +0100100 target_siginfo_t info;
pbrook624f7972008-05-31 16:11:38 +0000101};
102
bellard851e67a2003-03-29 16:53:14 +0000103/* NOTE: we force a big alignment so that the stack stored after is
104 aligned too */
105typedef struct TaskState {
Mika Westerbergedf8e2a2009-04-07 09:57:11 +0300106 pid_t ts_tid; /* tid (or pid) of this task */
bellard28c4f362004-02-16 21:47:43 +0000107#ifdef TARGET_ARM
Peter Maydell848d72c2013-09-03 20:12:17 +0100108# ifdef TARGET_ABI32
bellard28c4f362004-02-16 21:47:43 +0000109 /* FPA state */
110 FPA11 fpa;
Peter Maydell848d72c2013-09-03 20:12:17 +0100111# endif
bellarda4f81972005-04-23 18:25:41 +0000112 int swi_errno;
bellard28c4f362004-02-16 21:47:43 +0000113#endif
j_mayer84409dd2007-04-06 08:56:50 +0000114#if defined(TARGET_I386) && !defined(TARGET_X86_64)
blueswir1992f48a2007-10-14 16:27:31 +0000115 abi_ulong target_v86;
bellard851e67a2003-03-29 16:53:14 +0000116 struct vm86_saved_state vm86_saved_regs;
bellardb333af02003-05-14 21:48:51 +0000117 struct target_vm86plus_struct vm86plus;
bellard631271d2003-05-10 13:14:52 +0000118 uint32_t v86flags;
119 uint32_t v86mask;
bellardb346ff42003-06-15 20:05:50 +0000120#endif
pbrookc2764712009-03-07 15:24:59 +0000121 abi_ulong child_tidptr;
pbrooke6e59062006-10-22 00:18:54 +0000122#ifdef TARGET_M68K
Peter Maydell1ccd9372013-07-16 18:44:55 +0100123 abi_ulong tp_value;
pbrooke6e59062006-10-22 00:18:54 +0000124#endif
Peter Maydelldaa43742018-03-08 14:47:32 +0000125#if defined(TARGET_ARM) || defined(TARGET_M68K)
pbrooka87295e2007-05-26 15:09:38 +0000126 /* Extra fields for semihosted binaries. */
Peter Maydelld3170912016-07-04 13:06:35 +0100127 abi_ulong heap_base;
128 abi_ulong heap_limit;
pbrooka87295e2007-05-26 15:09:38 +0000129#endif
Peter Maydelld3170912016-07-04 13:06:35 +0100130 abi_ulong stack_base;
bellard851e67a2003-03-29 16:53:14 +0000131 int used; /* non zero if used */
pbrook978efd62006-06-17 18:30:42 +0000132 struct image_info *info;
Mika Westerbergedf8e2a2009-04-07 09:57:11 +0300133 struct linux_binprm *bprm;
pbrook624f7972008-05-31 16:11:38 +0000134
Timothy E Baldwin655ed672016-05-27 15:51:53 +0100135 struct emulated_sigtable sync_signal;
pbrook624f7972008-05-31 16:11:38 +0000136 struct emulated_sigtable sigtab[TARGET_NSIG];
Peter Maydell3d3efba2016-05-27 15:51:49 +0100137 /* This thread's signal mask, as requested by the guest program.
138 * The actual signal mask of this thread may differ:
139 * + we don't let SIGSEGV and SIGBUS be blocked while running guest code
140 * + sometimes we block all signals to avoid races
141 */
142 sigset_t signal_mask;
143 /* The signal mask imposed by a guest sigsuspend syscall, if we are
144 * currently in the middle of such a syscall
145 */
146 sigset_t sigsuspend_mask;
147 /* Nonzero if we're leaving a sigsuspend and sigsuspend_mask is valid. */
148 int in_sigsuspend;
149
150 /* Nonzero if process_pending_signals() needs to do something (either
151 * handle a pending signal or unblock signals).
152 * This flag is written from a signal handler so should be accessed via
Stefan Hajnoczid73415a2020-09-23 11:56:46 +0100153 * the qatomic_read() and qatomic_set() functions. (It is not accessed
Peter Maydell3d3efba2016-05-27 15:51:49 +0100154 * from multiple threads.)
155 */
156 int signal_pending;
157
Peter Maydell5bfce0b2019-07-25 14:16:45 +0100158 /* This thread's sigaltstack, if it has one */
159 struct target_sigaltstack sigaltstack_used;
bellard851e67a2003-03-29 16:53:14 +0000160} __attribute__((aligned(16))) TaskState;
161
aurel32d088d662009-01-30 20:09:01 +0000162extern char *exec_path;
pbrook624f7972008-05-31 16:11:38 +0000163void init_task_state(TaskState *ts);
Mika Westerbergedf8e2a2009-04-07 09:57:11 +0300164void task_settid(TaskState *);
165void stop_all_tasks(void);
pbrookc5937222006-05-14 11:30:38 +0000166extern const char *qemu_uname_release;
Paul Brook379f6692009-07-17 12:48:08 +0100167extern unsigned long mmap_min_addr;
bellard851e67a2003-03-29 16:53:14 +0000168
pbrooke5fe0c52006-06-11 13:32:59 +0000169/* ??? See if we can avoid exposing so much of the loader internals. */
pbrooke5fe0c52006-06-11 13:32:59 +0000170
Richard Henderson9955ffa2010-07-27 10:25:30 -0700171/* Read a good amount of data initially, to hopefully get all the
172 program headers loaded. */
173#define BPRM_BUF_SIZE 1024
174
pbrooke5fe0c52006-06-11 13:32:59 +0000175/*
ths5fafdf22007-09-16 21:08:06 +0000176 * This structure is used to hold the arguments that are
pbrooke5fe0c52006-06-11 13:32:59 +0000177 * used when loading binaries.
178 */
179struct linux_binprm {
Richard Henderson9955ffa2010-07-27 10:25:30 -0700180 char buf[BPRM_BUF_SIZE] __attribute__((aligned));
blueswir1992f48a2007-10-14 16:27:31 +0000181 abi_ulong p;
Paolo Bonzini7d374352018-12-13 23:37:37 +0100182 int fd;
pbrooke5fe0c52006-06-11 13:32:59 +0000183 int e_uid, e_gid;
184 int argc, envc;
185 char **argv;
186 char **envp;
187 char * filename; /* Name of binary */
Andreas Färber9349b4f2012-03-14 01:38:32 +0100188 int (*core_dump)(int, const CPUArchState *); /* coredump routine */
pbrooke5fe0c52006-06-11 13:32:59 +0000189};
190
Filip Bozuta79482e592020-06-19 14:47:27 +0200191typedef struct IOCTLEntry IOCTLEntry;
192
193typedef abi_long do_ioctl_fn(const IOCTLEntry *ie, uint8_t *buf_temp,
194 int fd, int cmd, abi_long arg);
195
196struct IOCTLEntry {
197 int target_cmd;
198 unsigned int host_cmd;
199 const char *name;
200 int access;
201 do_ioctl_fn *do_ioctl;
202 const argtype arg_type[5];
203};
204
205extern IOCTLEntry ioctl_entries[];
206
207#define IOC_R 0x0001
208#define IOC_W 0x0002
209#define IOC_RW (IOC_R | IOC_W)
210
pbrooke5fe0c52006-06-11 13:32:59 +0000211void do_init_thread(struct target_pt_regs *regs, struct image_info *infop);
blueswir1992f48a2007-10-14 16:27:31 +0000212abi_ulong loader_build_argptr(int envc, int argc, abi_ulong sp,
213 abi_ulong stringp, int push_ptr);
Laurent Vivier03cfd8f2013-08-30 01:46:44 +0200214int loader_exec(int fdexec, const char *filename, char **argv, char **envp,
Mika Westerbergedf8e2a2009-04-07 09:57:11 +0300215 struct target_pt_regs * regs, struct image_info *infop,
216 struct linux_binprm *);
bellard31e31b82003-02-18 22:55:36 +0000217
Christophe Lyon3cb10cf2018-04-30 10:03:43 +0200218/* Returns true if the image uses the FDPIC ABI. If this is the case,
219 * we have to provide some information (loadmap, pt_dynamic_info) such
220 * that the program can be relocated adequately. This is also useful
221 * when handling signals.
222 */
223int info_is_fdpic(struct image_info *info);
224
YunQiang Su768fe762018-02-20 18:33:05 +0100225uint32_t get_elf_eflags(int fd);
Will Newtonf0116c52014-01-09 09:10:50 +0000226int load_elf_binary(struct linux_binprm *bprm, struct image_info *info);
227int load_flt_binary(struct linux_binprm *bprm, struct image_info *info);
pbrooke5fe0c52006-06-11 13:32:59 +0000228
bellard579a97f2007-11-11 14:26:47 +0000229abi_long memcpy_to_target(abi_ulong dest, const void *src,
230 unsigned long len);
blueswir1992f48a2007-10-14 16:27:31 +0000231void target_set_brk(abi_ulong new_brk);
232abi_long do_brk(abi_ulong new_brk);
bellard31e31b82003-02-18 22:55:36 +0000233void syscall_init(void);
blueswir1992f48a2007-10-14 16:27:31 +0000234abi_long do_syscall(void *cpu_env, int num, abi_long arg1,
235 abi_long arg2, abi_long arg3, abi_long arg4,
Peter Maydell5945cfc2011-06-16 17:37:13 +0100236 abi_long arg5, abi_long arg6, abi_long arg7,
237 abi_long arg8);
Peter Maydellb44316f2018-02-13 13:22:46 +0000238extern __thread CPUState *thread_cpu;
Andreas Färber9349b4f2012-03-14 01:38:32 +0100239void cpu_loop(CPUArchState *env);
Peter Maydell7dcdaea2016-06-06 19:58:18 +0100240const char *target_strerror(int err);
pbrooka745ec62008-05-06 15:36:17 +0000241int get_osversion(void);
Peter Maydell4a24a752013-09-03 20:12:20 +0100242void init_qemu_uname_release(void);
pbrookd5975362008-06-07 20:50:51 +0000243void fork_start(void);
244void fork_end(int child);
bellard6977fbf2003-04-29 20:39:23 +0000245
Alex Bennéeee947432020-05-13 18:51:28 +0100246/**
247 * probe_guest_base:
248 * @image_name: the executable being loaded
249 * @loaddr: the lowest fixed address in the executable
250 * @hiaddr: the highest fixed address in the executable
251 *
252 * Creates the initial guest address space in the host memory space.
253 *
254 * If @loaddr == 0, then no address in the executable is fixed,
255 * i.e. it is fully relocatable. In that case @hiaddr is the size
256 * of the executable.
257 *
258 * This function will not return if a valid value for guest_base
259 * cannot be chosen. On return, the executable loader can expect
260 *
261 * target_mmap(loaddr, hiaddr - loaddr, ...)
262 *
263 * to succeed.
Meador Ingedce10402012-07-26 16:50:01 +0000264 */
Alex Bennéeee947432020-05-13 18:51:28 +0100265void probe_guest_base(const char *image_name,
266 abi_ulong loaddr, abi_ulong hiaddr);
Meador Ingedce10402012-07-26 16:50:01 +0000267
Paolo Bonzini1de7afc2012-12-17 18:20:00 +0100268#include "qemu/log.h"
bellard631271d2003-05-10 13:14:52 +0000269
Timothy E Baldwin4d330ce2016-05-12 18:47:46 +0100270/* safe_syscall.S */
271
272/**
273 * safe_syscall:
274 * @int number: number of system call to make
275 * ...: arguments to the system call
276 *
277 * Call a system call if guest signal not pending.
278 * This has the same API as the libc syscall() function, except that it
279 * may return -1 with errno == TARGET_ERESTARTSYS if a signal was pending.
280 *
281 * Returns: the system call result, or -1 with an error code in errno
282 * (Errnos are host errnos; we rely on TARGET_ERESTARTSYS not clashing
283 * with any of the host errno values.)
284 */
285
286/* A guide to using safe_syscall() to handle interactions between guest
287 * syscalls and guest signals:
288 *
289 * Guest syscalls come in two flavours:
290 *
291 * (1) Non-interruptible syscalls
292 *
293 * These are guest syscalls that never get interrupted by signals and
294 * so never return EINTR. They can be implemented straightforwardly in
295 * QEMU: just make sure that if the implementation code has to make any
296 * blocking calls that those calls are retried if they return EINTR.
297 * It's also OK to implement these with safe_syscall, though it will be
298 * a little less efficient if a signal is delivered at the 'wrong' moment.
299 *
Peter Maydell3d3efba2016-05-27 15:51:49 +0100300 * Some non-interruptible syscalls need to be handled using block_signals()
301 * to block signals for the duration of the syscall. This mainly applies
302 * to code which needs to modify the data structures used by the
303 * host_signal_handler() function and the functions it calls, including
304 * all syscalls which change the thread's signal mask.
305 *
Timothy E Baldwin4d330ce2016-05-12 18:47:46 +0100306 * (2) Interruptible syscalls
307 *
308 * These are guest syscalls that can be interrupted by signals and
309 * for which we need to either return EINTR or arrange for the guest
310 * syscall to be restarted. This category includes both syscalls which
311 * always restart (and in the kernel return -ERESTARTNOINTR), ones
312 * which only restart if there is no handler (kernel returns -ERESTARTNOHAND
313 * or -ERESTART_RESTARTBLOCK), and the most common kind which restart
314 * if the handler was registered with SA_RESTART (kernel returns
315 * -ERESTARTSYS). System calls which are only interruptible in some
316 * situations (like 'open') also need to be handled this way.
317 *
318 * Here it is important that the host syscall is made
319 * via this safe_syscall() function, and *not* via the host libc.
320 * If the host libc is used then the implementation will appear to work
321 * most of the time, but there will be a race condition where a
322 * signal could arrive just before we make the host syscall inside libc,
323 * and then then guest syscall will not correctly be interrupted.
324 * Instead the implementation of the guest syscall can use the safe_syscall
325 * function but otherwise just return the result or errno in the usual
326 * way; the main loop code will take care of restarting the syscall
327 * if appropriate.
328 *
329 * (If the implementation needs to make multiple host syscalls this is
330 * OK; any which might really block must be via safe_syscall(); for those
331 * which are only technically blocking (ie which we know in practice won't
332 * stay in the host kernel indefinitely) it's OK to use libc if necessary.
333 * You must be able to cope with backing out correctly if some safe_syscall
334 * you make in the implementation returns either -TARGET_ERESTARTSYS or
335 * EINTR though.)
336 *
Peter Maydell3d3efba2016-05-27 15:51:49 +0100337 * block_signals() cannot be used for interruptible syscalls.
338 *
Timothy E Baldwin4d330ce2016-05-12 18:47:46 +0100339 *
340 * How and why the safe_syscall implementation works:
341 *
342 * The basic setup is that we make the host syscall via a known
343 * section of host native assembly. If a signal occurs, our signal
344 * handler checks the interrupted host PC against the addresse of that
345 * known section. If the PC is before or at the address of the syscall
346 * instruction then we change the PC to point at a "return
347 * -TARGET_ERESTARTSYS" code path instead, and then exit the signal handler
348 * (causing the safe_syscall() call to immediately return that value).
349 * Then in the main.c loop if we see this magic return value we adjust
350 * the guest PC to wind it back to before the system call, and invoke
351 * the guest signal handler as usual.
352 *
353 * This winding-back will happen in two cases:
354 * (1) signal came in just before we took the host syscall (a race);
355 * in this case we'll take the guest signal and have another go
356 * at the syscall afterwards, and this is indistinguishable for the
357 * guest from the timing having been different such that the guest
358 * signal really did win the race
359 * (2) signal came in while the host syscall was blocking, and the
360 * host kernel decided the syscall should be restarted;
361 * in this case we want to restart the guest syscall also, and so
362 * rewinding is the right thing. (Note that "restart" semantics mean
363 * "first call the signal handler, then reattempt the syscall".)
364 * The other situation to consider is when a signal came in while the
365 * host syscall was blocking, and the host kernel decided that the syscall
366 * should not be restarted; in this case QEMU's host signal handler will
367 * be invoked with the PC pointing just after the syscall instruction,
368 * with registers indicating an EINTR return; the special code in the
369 * handler will not kick in, and we will return EINTR to the guest as
370 * we should.
371 *
372 * Notice that we can leave the host kernel to make the decision for
373 * us about whether to do a restart of the syscall or not; we do not
374 * need to check SA_RESTART flags in QEMU or distinguish the various
375 * kinds of restartability.
376 */
377#ifdef HAVE_SAFE_SYSCALL
378/* The core part of this function is implemented in assembly */
379extern long safe_syscall_base(int *pending, long number, ...);
380
381#define safe_syscall(...) \
382 ({ \
383 long ret_; \
384 int *psp_ = &((TaskState *)thread_cpu->opaque)->signal_pending; \
385 ret_ = safe_syscall_base(psp_, __VA_ARGS__); \
386 if (is_error(ret_)) { \
387 errno = -ret_; \
388 ret_ = -1; \
389 } \
390 ret_; \
391 })
392
393#else
394
395/* Fallback for architectures which don't yet provide a safe-syscall assembly
396 * fragment; note that this is racy!
397 * This should go away when all host architectures have been updated.
398 */
399#define safe_syscall syscall
400
401#endif
402
Richard Hendersona05c6402012-09-15 11:34:20 -0700403/* syscall.c */
404int host_to_target_waitstatus(int status);
405
thsb92c47c2007-11-01 00:07:38 +0000406/* strace.c */
Filip Bozutae400e112020-08-11 18:45:49 +0200407void print_syscall(void *cpu_env, int num,
bellardc16f9ed2007-11-11 17:23:29 +0000408 abi_long arg1, abi_long arg2, abi_long arg3,
409 abi_long arg4, abi_long arg5, abi_long arg6);
Filip Bozutae400e112020-08-11 18:45:49 +0200410void print_syscall_ret(void *cpu_env, int num, abi_long ret,
Filip Bozutac84be712020-06-19 14:33:26 +0200411 abi_long arg1, abi_long arg2, abi_long arg3,
412 abi_long arg4, abi_long arg5, abi_long arg6);
Peter Maydell0cb581d2016-07-18 18:12:24 +0100413/**
414 * print_taken_signal:
415 * @target_signum: target signal being taken
416 * @tinfo: target_siginfo_t which will be passed to the guest for the signal
417 *
418 * Print strace output indicating that this signal is being taken by the guest,
419 * in a format similar to:
420 * --- SIGSEGV {si_signo=SIGSEGV, si_code=SI_KERNEL, si_addr=0} ---
421 */
422void print_taken_signal(int target_signum, const target_siginfo_t *tinfo);
thsb92c47c2007-11-01 00:07:38 +0000423
bellardb346ff42003-06-15 20:05:50 +0000424/* signal.c */
Andreas Färber9349b4f2012-03-14 01:38:32 +0100425void process_pending_signals(CPUArchState *cpu_env);
bellardb346ff42003-06-15 20:05:50 +0000426void signal_init(void);
Peter Maydell9d2803f2016-07-28 16:44:46 +0100427int queue_signal(CPUArchState *env, int sig, int si_type,
428 target_siginfo_t *info);
Anthony Liguoric227f092009-10-01 16:12:16 -0500429void host_to_target_siginfo(target_siginfo_t *tinfo, const siginfo_t *info);
430void target_to_host_siginfo(siginfo_t *info, const target_siginfo_t *tinfo);
pbrook4cb05962008-05-30 18:05:19 +0000431int target_to_host_signal(int sig);
pbrook1d9d8b52009-04-16 15:17:02 +0000432int host_to_target_signal(int sig);
Andreas Färber9349b4f2012-03-14 01:38:32 +0100433long do_sigreturn(CPUArchState *env);
434long do_rt_sigreturn(CPUArchState *env);
bellard579a97f2007-11-11 14:26:47 +0000435abi_long do_sigaltstack(abi_ulong uss_addr, abi_ulong uoss_addr, abi_ulong sp);
Alex Barcelo1c275922014-03-14 14:36:55 +0000436int do_sigprocmask(int how, const sigset_t *set, sigset_t *oldset);
Richard Hendersonfa97e382018-07-18 13:06:48 -0700437abi_long do_swapcontext(CPUArchState *env, abi_ulong uold_ctx,
438 abi_ulong unew_ctx, abi_long ctx_size);
Peter Maydell3d3efba2016-05-27 15:51:49 +0100439/**
440 * block_signals: block all signals while handling this guest syscall
441 *
442 * Block all signals, and arrange that the signal mask is returned to
443 * its correct value for the guest before we resume execution of guest code.
444 * If this function returns non-zero, then the caller should immediately
445 * return -TARGET_ERESTARTSYS to the main loop, which will take the pending
446 * signal and restart execution of the syscall.
447 * If block_signals() returns zero, then the caller can continue with
448 * emulation of the system call knowing that no signals can be taken
449 * (and therefore that no race conditions will result).
450 * This should only be called once, because if it is called a second time
451 * it will always return non-zero. (Think of it like a mutex that can't
452 * be recursively locked.)
453 * Signals will be unblocked again by process_pending_signals().
454 *
455 * Return value: non-zero if there was a pending signal, zero if not.
456 */
457int block_signals(void); /* Returns non zero if signal pending */
bellardb346ff42003-06-15 20:05:50 +0000458
459#ifdef TARGET_I386
bellard631271d2003-05-10 13:14:52 +0000460/* vm86.c */
461void save_v86_state(CPUX86State *env);
bellard447db212003-05-10 15:10:36 +0000462void handle_vm86_trap(CPUX86State *env, int trapno);
bellard631271d2003-05-10 13:14:52 +0000463void handle_vm86_fault(CPUX86State *env);
blueswir1992f48a2007-10-14 16:27:31 +0000464int do_vm86(CPUX86State *env, long subfunction, abi_ulong v86_addr);
blueswir15bfb56b2007-10-05 17:01:51 +0000465#elif defined(TARGET_SPARC64)
466void sparc64_set_context(CPUSPARCState *env);
467void sparc64_get_context(CPUSPARCState *env);
bellardb346ff42003-06-15 20:05:50 +0000468#endif
bellard631271d2003-05-10 13:14:52 +0000469
bellard54936002003-05-13 00:25:15 +0000470/* mmap.c */
blueswir1992f48a2007-10-14 16:27:31 +0000471int target_mprotect(abi_ulong start, abi_ulong len, int prot);
472abi_long target_mmap(abi_ulong start, abi_ulong len, int prot,
473 int flags, int fd, abi_ulong offset);
474int target_munmap(abi_ulong start, abi_ulong len);
475abi_long target_mremap(abi_ulong old_addr, abi_ulong old_size,
476 abi_ulong new_size, unsigned long flags,
477 abi_ulong new_addr);
pbrook07765902008-05-31 16:33:53 +0000478extern unsigned long last_brk;
Peter Maydell59e9d912012-03-08 14:40:33 +0000479extern abi_ulong mmap_next_start;
Richard Henderson30ab9ef2019-05-19 13:19:52 -0700480abi_ulong mmap_find_vma(abi_ulong, abi_ulong, abi_ulong);
pbrookd5975362008-06-07 20:50:51 +0000481void mmap_fork_start(void);
482void mmap_fork_end(int child);
bellard54936002003-05-13 00:25:15 +0000483
blueswir1440c7e82008-10-05 11:05:14 +0000484/* main.c */
Richard Henderson703e0e82010-03-19 14:21:13 -0700485extern unsigned long guest_stack_size;
blueswir1440c7e82008-10-05 11:05:14 +0000486
bellardedf779f2004-02-22 13:40:13 +0000487/* user access */
488
489#define VERIFY_READ 0
bellard579a97f2007-11-11 14:26:47 +0000490#define VERIFY_WRITE 1 /* implies read access */
bellardedf779f2004-02-22 13:40:13 +0000491
bellarddae32702007-11-14 10:51:00 +0000492static inline int access_ok(int type, abi_ulong addr, abi_ulong size)
493{
Rémi Denis-Courmont0acd4ab2019-07-04 10:41:15 +0200494 return guest_addr_valid(addr) &&
495 (size == 0 || guest_addr_valid(addr + size - 1)) &&
496 page_check_range((target_ulong)addr, size,
bellarddae32702007-11-14 10:51:00 +0000497 (type == VERIFY_READ) ? PAGE_READ : (PAGE_READ | PAGE_WRITE)) == 0;
498}
bellardedf779f2004-02-22 13:40:13 +0000499
Richard Henderson658f2dc2013-01-04 16:39:31 -0800500/* NOTE __get_user and __put_user use host pointers and don't check access.
501 These are usually used to access struct data members once the struct has
502 been locked - usually with lock_user_struct. */
bellardedf779f2004-02-22 13:40:13 +0000503
Peter Maydell850d5e32018-10-09 17:18:14 +0100504/*
505 * Tricky points:
506 * - Use __builtin_choose_expr to avoid type promotion from ?:,
507 * - Invalid sizes result in a compile time error stemming from
508 * the fact that abort has no parameters.
509 * - It's easier to use the endian-specific unaligned load/store
510 * functions than host-endian unaligned load/store plus tswapN.
511 * - The pragmas are necessary only to silence a clang false-positive
512 * warning: see https://bugs.llvm.org/show_bug.cgi?id=39113 .
Peter Maydell850d5e32018-10-09 17:18:14 +0100513 * - gcc has bugs in its _Pragma() support in some versions, eg
514 * https://gcc.gnu.org/bugzilla/show_bug.cgi?id=83256 -- so we only
515 * include the warning-suppression pragmas for clang
516 */
Thomas Huth798b8582018-11-30 09:23:16 +0100517#if defined(__clang__) && __has_warning("-Waddress-of-packed-member")
Peter Maydell850d5e32018-10-09 17:18:14 +0100518#define PRAGMA_DISABLE_PACKED_WARNING \
519 _Pragma("GCC diagnostic push"); \
Peter Maydell850d5e32018-10-09 17:18:14 +0100520 _Pragma("GCC diagnostic ignored \"-Waddress-of-packed-member\"")
Richard Henderson658f2dc2013-01-04 16:39:31 -0800521
Peter Maydell850d5e32018-10-09 17:18:14 +0100522#define PRAGMA_REENABLE_PACKED_WARNING \
523 _Pragma("GCC diagnostic pop")
Richard Henderson658f2dc2013-01-04 16:39:31 -0800524
Peter Maydell850d5e32018-10-09 17:18:14 +0100525#else
526#define PRAGMA_DISABLE_PACKED_WARNING
527#define PRAGMA_REENABLE_PACKED_WARNING
528#endif
529
530#define __put_user_e(x, hptr, e) \
531 do { \
532 PRAGMA_DISABLE_PACKED_WARNING; \
533 (__builtin_choose_expr(sizeof(*(hptr)) == 1, stb_p, \
534 __builtin_choose_expr(sizeof(*(hptr)) == 2, stw_##e##_p, \
535 __builtin_choose_expr(sizeof(*(hptr)) == 4, stl_##e##_p, \
536 __builtin_choose_expr(sizeof(*(hptr)) == 8, stq_##e##_p, abort)))) \
537 ((hptr), (x)), (void)0); \
538 PRAGMA_REENABLE_PACKED_WARNING; \
539 } while (0)
540
541#define __get_user_e(x, hptr, e) \
542 do { \
543 PRAGMA_DISABLE_PACKED_WARNING; \
544 ((x) = (typeof(*hptr))( \
545 __builtin_choose_expr(sizeof(*(hptr)) == 1, ldub_p, \
546 __builtin_choose_expr(sizeof(*(hptr)) == 2, lduw_##e##_p, \
547 __builtin_choose_expr(sizeof(*(hptr)) == 4, ldl_##e##_p, \
548 __builtin_choose_expr(sizeof(*(hptr)) == 8, ldq_##e##_p, abort)))) \
549 (hptr)), (void)0); \
550 PRAGMA_REENABLE_PACKED_WARNING; \
551 } while (0)
552
Richard Henderson658f2dc2013-01-04 16:39:31 -0800553
554#ifdef TARGET_WORDS_BIGENDIAN
555# define __put_user(x, hptr) __put_user_e(x, hptr, be)
556# define __get_user(x, hptr) __get_user_e(x, hptr, be)
557#else
558# define __put_user(x, hptr) __put_user_e(x, hptr, le)
559# define __get_user(x, hptr) __get_user_e(x, hptr, le)
560#endif
bellardedf779f2004-02-22 13:40:13 +0000561
bellard579a97f2007-11-11 14:26:47 +0000562/* put_user()/get_user() take a guest address and check access */
563/* These are usually used to access an atomic data type, such as an int,
564 * that has been passed by address. These internally perform locking
565 * and unlocking on the data type.
566 */
567#define put_user(x, gaddr, target_type) \
568({ \
569 abi_ulong __gaddr = (gaddr); \
570 target_type *__hptr; \
Riku Voipioa42267e2014-04-22 15:40:50 +0300571 abi_long __ret = 0; \
bellard579a97f2007-11-11 14:26:47 +0000572 if ((__hptr = lock_user(VERIFY_WRITE, __gaddr, sizeof(target_type), 0))) { \
Riku Voipioa42267e2014-04-22 15:40:50 +0300573 __put_user((x), __hptr); \
bellard579a97f2007-11-11 14:26:47 +0000574 unlock_user(__hptr, __gaddr, sizeof(target_type)); \
575 } else \
576 __ret = -TARGET_EFAULT; \
577 __ret; \
bellardedf779f2004-02-22 13:40:13 +0000578})
579
bellard579a97f2007-11-11 14:26:47 +0000580#define get_user(x, gaddr, target_type) \
581({ \
582 abi_ulong __gaddr = (gaddr); \
583 target_type *__hptr; \
Riku Voipioa42267e2014-04-22 15:40:50 +0300584 abi_long __ret = 0; \
bellard579a97f2007-11-11 14:26:47 +0000585 if ((__hptr = lock_user(VERIFY_READ, __gaddr, sizeof(target_type), 1))) { \
Riku Voipioa42267e2014-04-22 15:40:50 +0300586 __get_user((x), __hptr); \
bellard579a97f2007-11-11 14:26:47 +0000587 unlock_user(__hptr, __gaddr, 0); \
bellard2f619692007-11-16 10:46:05 +0000588 } else { \
589 /* avoid warning */ \
590 (x) = 0; \
bellard579a97f2007-11-11 14:26:47 +0000591 __ret = -TARGET_EFAULT; \
bellard2f619692007-11-16 10:46:05 +0000592 } \
bellard579a97f2007-11-11 14:26:47 +0000593 __ret; \
bellardedf779f2004-02-22 13:40:13 +0000594})
595
bellard2f619692007-11-16 10:46:05 +0000596#define put_user_ual(x, gaddr) put_user((x), (gaddr), abi_ulong)
597#define put_user_sal(x, gaddr) put_user((x), (gaddr), abi_long)
598#define put_user_u64(x, gaddr) put_user((x), (gaddr), uint64_t)
599#define put_user_s64(x, gaddr) put_user((x), (gaddr), int64_t)
600#define put_user_u32(x, gaddr) put_user((x), (gaddr), uint32_t)
601#define put_user_s32(x, gaddr) put_user((x), (gaddr), int32_t)
602#define put_user_u16(x, gaddr) put_user((x), (gaddr), uint16_t)
603#define put_user_s16(x, gaddr) put_user((x), (gaddr), int16_t)
604#define put_user_u8(x, gaddr) put_user((x), (gaddr), uint8_t)
605#define put_user_s8(x, gaddr) put_user((x), (gaddr), int8_t)
606
607#define get_user_ual(x, gaddr) get_user((x), (gaddr), abi_ulong)
608#define get_user_sal(x, gaddr) get_user((x), (gaddr), abi_long)
609#define get_user_u64(x, gaddr) get_user((x), (gaddr), uint64_t)
610#define get_user_s64(x, gaddr) get_user((x), (gaddr), int64_t)
611#define get_user_u32(x, gaddr) get_user((x), (gaddr), uint32_t)
612#define get_user_s32(x, gaddr) get_user((x), (gaddr), int32_t)
613#define get_user_u16(x, gaddr) get_user((x), (gaddr), uint16_t)
614#define get_user_s16(x, gaddr) get_user((x), (gaddr), int16_t)
615#define get_user_u8(x, gaddr) get_user((x), (gaddr), uint8_t)
616#define get_user_s8(x, gaddr) get_user((x), (gaddr), int8_t)
617
bellard579a97f2007-11-11 14:26:47 +0000618/* copy_from_user() and copy_to_user() are usually used to copy data
619 * buffers between the target and host. These internally perform
620 * locking/unlocking of the memory.
621 */
622abi_long copy_from_user(void *hptr, abi_ulong gaddr, size_t len);
623abi_long copy_to_user(abi_ulong gaddr, void *hptr, size_t len);
624
pbrook53a59602006-03-25 19:31:22 +0000625/* Functions for accessing guest memory. The tget and tput functions
Stefan Weil6f20f552013-09-12 19:57:15 +0200626 read/write single values, byteswapping as necessary. The lock_user function
pbrook53a59602006-03-25 19:31:22 +0000627 gets a pointer to a contiguous area of guest memory, but does not perform
Stefan Weil6f20f552013-09-12 19:57:15 +0200628 any byteswapping. lock_user may return either a pointer to the guest
pbrook53a59602006-03-25 19:31:22 +0000629 memory, or a temporary buffer. */
630
631/* Lock an area of guest memory into the host. If copy is true then the
632 host area will have the same contents as the guest. */
bellard579a97f2007-11-11 14:26:47 +0000633static inline void *lock_user(int type, abi_ulong guest_addr, long len, int copy)
bellardedf779f2004-02-22 13:40:13 +0000634{
bellard579a97f2007-11-11 14:26:47 +0000635 if (!access_ok(type, guest_addr, len))
636 return NULL;
pbrook53a59602006-03-25 19:31:22 +0000637#ifdef DEBUG_REMAP
bellard579a97f2007-11-11 14:26:47 +0000638 {
639 void *addr;
Md Haris Iqbal38e826d2016-03-24 00:02:03 +0530640 addr = g_malloc(len);
bellard579a97f2007-11-11 14:26:47 +0000641 if (copy)
642 memcpy(addr, g2h(guest_addr), len);
643 else
644 memset(addr, 0, len);
645 return addr;
646 }
pbrook53a59602006-03-25 19:31:22 +0000647#else
648 return g2h(guest_addr);
649#endif
bellardedf779f2004-02-22 13:40:13 +0000650}
651
bellard579a97f2007-11-11 14:26:47 +0000652/* Unlock an area of guest memory. The first LEN bytes must be
ths1235fc02008-06-03 19:51:57 +0000653 flushed back to guest memory. host_ptr = NULL is explicitly
bellard579a97f2007-11-11 14:26:47 +0000654 allowed and does nothing. */
655static inline void unlock_user(void *host_ptr, abi_ulong guest_addr,
blueswir1992f48a2007-10-14 16:27:31 +0000656 long len)
bellardedf779f2004-02-22 13:40:13 +0000657{
bellard579a97f2007-11-11 14:26:47 +0000658
pbrook53a59602006-03-25 19:31:22 +0000659#ifdef DEBUG_REMAP
bellard579a97f2007-11-11 14:26:47 +0000660 if (!host_ptr)
661 return;
662 if (host_ptr == g2h(guest_addr))
pbrook53a59602006-03-25 19:31:22 +0000663 return;
664 if (len > 0)
balrog06177d32007-12-24 13:47:52 +0000665 memcpy(g2h(guest_addr), host_ptr, len);
Md Haris Iqbal38e826d2016-03-24 00:02:03 +0530666 g_free(host_ptr);
pbrook53a59602006-03-25 19:31:22 +0000667#endif
bellardedf779f2004-02-22 13:40:13 +0000668}
669
bellard579a97f2007-11-11 14:26:47 +0000670/* Return the length of a string in target memory or -TARGET_EFAULT if
671 access error. */
672abi_long target_strlen(abi_ulong gaddr);
bellardedf779f2004-02-22 13:40:13 +0000673
pbrook53a59602006-03-25 19:31:22 +0000674/* Like lock_user but for null terminated strings. */
blueswir1992f48a2007-10-14 16:27:31 +0000675static inline void *lock_user_string(abi_ulong guest_addr)
pbrook53a59602006-03-25 19:31:22 +0000676{
bellard579a97f2007-11-11 14:26:47 +0000677 abi_long len;
678 len = target_strlen(guest_addr);
679 if (len < 0)
680 return NULL;
681 return lock_user(VERIFY_READ, guest_addr, (long)(len + 1), 1);
pbrook53a59602006-03-25 19:31:22 +0000682}
683
Stefan Weil41d1af42013-09-12 19:57:41 +0200684/* Helper macros for locking/unlocking a target struct. */
bellard579a97f2007-11-11 14:26:47 +0000685#define lock_user_struct(type, host_ptr, guest_addr, copy) \
686 (host_ptr = lock_user(type, guest_addr, sizeof(*host_ptr), copy))
687#define unlock_user_struct(host_ptr, guest_addr, copy) \
pbrook53a59602006-03-25 19:31:22 +0000688 unlock_user(host_ptr, guest_addr, (copy) ? sizeof(*host_ptr) : 0)
689
pbrookc8a706f2008-06-02 16:16:42 +0000690#include <pthread.h>
pbrookc8a706f2008-06-02 16:16:42 +0000691
Philippe Mathieu-Daudé1129dd72018-06-04 12:37:21 -0300692static inline int is_error(abi_long ret)
693{
694 return (abi_ulong)ret >= (abi_ulong)(-4096);
695}
696
Filip Bozutaf4d92c52020-06-19 14:33:31 +0200697#if TARGET_ABI_BITS == 32
698static inline uint64_t target_offset64(uint32_t word0, uint32_t word1)
699{
700#ifdef TARGET_WORDS_BIGENDIAN
701 return ((uint64_t)word0 << 32) | word1;
702#else
703 return ((uint64_t)word1 << 32) | word0;
704#endif
705}
706#else /* TARGET_ABI_BITS == 32 */
707static inline uint64_t target_offset64(uint64_t word0, uint64_t word1)
708{
709 return word0;
710}
711#endif /* TARGET_ABI_BITS != 32 */
712
Filip Bozuta888468d2020-07-23 23:02:33 +0200713void print_termios(void *arg);
Filip Bozuta7c89f342020-08-11 18:45:50 +0200714
715/* ARM EABI and MIPS expect 64bit types aligned even on pairs or registers */
716#ifdef TARGET_ARM
717static inline int regpairs_aligned(void *cpu_env, int num)
718{
719 return ((((CPUARMState *)cpu_env)->eabi) == 1) ;
720}
721#elif defined(TARGET_MIPS) && (TARGET_ABI_BITS == 32)
722static inline int regpairs_aligned(void *cpu_env, int num) { return 1; }
723#elif defined(TARGET_PPC) && !defined(TARGET_PPC64)
724/*
725 * SysV AVI for PPC32 expects 64bit parameters to be passed on odd/even pairs
726 * of registers which translates to the same as ARM/MIPS, because we start with
727 * r3 as arg1
728 */
729static inline int regpairs_aligned(void *cpu_env, int num) { return 1; }
730#elif defined(TARGET_SH4)
731/* SH4 doesn't align register pairs, except for p{read,write}64 */
732static inline int regpairs_aligned(void *cpu_env, int num)
733{
734 switch (num) {
735 case TARGET_NR_pread64:
736 case TARGET_NR_pwrite64:
737 return 1;
738
739 default:
740 return 0;
741 }
742}
743#elif defined(TARGET_XTENSA)
744static inline int regpairs_aligned(void *cpu_env, int num) { return 1; }
745#else
746static inline int regpairs_aligned(void *cpu_env, int num) { return 0; }
747#endif
748
Alex Bennée708b6a62018-06-22 17:09:10 +0100749/**
750 * preexit_cleanup: housekeeping before the guest exits
751 *
752 * env: the CPU state
753 * code: the exit code
754 */
755void preexit_cleanup(CPUArchState *env, int code);
756
Peter Maydelldfeab062013-07-16 18:44:52 +0100757/* Include target-specific struct and function definitions;
758 * they may need access to the target-independent structures
759 * above, so include them last.
760 */
761#include "target_cpu.h"
Petar Jovanovic55a2b162013-10-30 14:46:31 +0100762#include "target_structs.h"
Peter Maydelldfeab062013-07-16 18:44:52 +0100763
bellarde88de092005-02-07 12:35:39 +0000764#endif /* QEMU_H */