blob: da73a01106b68acde06480fd385b372e485f681e [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"
Paolo Bonzini1de7afc2012-12-17 18:20:00 +010019#include "qemu/queue.h"
bellard66fb9762003-03-23 01:06:05 +000020
pbrookd5975362008-06-07 20:50:51 +000021#define THREAD __thread
pbrookd5975362008-06-07 20:50:51 +000022
Peter Maydell1d48fdd2016-06-14 12:49:18 +010023/* This is the size of the host kernel's sigset_t, needed where we make
24 * direct system calls that take a sigset_t pointer and a size.
25 */
26#define SIGSET_T_SIZE (_NSIG / 8)
27
bellard31e31b82003-02-18 22:55:36 +000028/* This struct is used to hold certain information about the image.
29 * Basically, it replicates in user space what would be certain
30 * task_struct fields in the kernel
31 */
32struct image_info {
Richard Henderson9955ffa2010-07-27 10:25:30 -070033 abi_ulong load_bias;
blueswir1992f48a2007-10-14 16:27:31 +000034 abi_ulong load_addr;
35 abi_ulong start_code;
36 abi_ulong end_code;
37 abi_ulong start_data;
38 abi_ulong end_data;
39 abi_ulong start_brk;
40 abi_ulong brk;
41 abi_ulong start_mmap;
blueswir1992f48a2007-10-14 16:27:31 +000042 abi_ulong start_stack;
Paul Brook97374d32010-06-16 13:03:51 +010043 abi_ulong stack_limit;
blueswir1992f48a2007-10-14 16:27:31 +000044 abi_ulong entry;
45 abi_ulong code_offset;
46 abi_ulong data_offset;
Mika Westerbergedf8e2a2009-04-07 09:57:11 +030047 abi_ulong saved_auxv;
Alexander Graf125b0f52012-01-28 21:12:14 +020048 abi_ulong auxv_len;
Mika Westerbergedf8e2a2009-04-07 09:57:11 +030049 abi_ulong arg_start;
50 abi_ulong arg_end;
Paul Brookd8fd2952012-03-30 18:02:50 +010051 uint32_t elf_flags;
bellard31e31b82003-02-18 22:55:36 +000052 int personality;
Mike Frysinger1af02e82011-02-07 01:05:50 -050053#ifdef CONFIG_USE_FDPIC
54 abi_ulong loadmap_addr;
55 uint16_t nsegs;
56 void *loadsegs;
57 abi_ulong pt_dynamic_addr;
58 struct image_info *other_info;
59#endif
bellard31e31b82003-02-18 22:55:36 +000060};
61
bellardb346ff42003-06-15 20:05:50 +000062#ifdef TARGET_I386
bellard851e67a2003-03-29 16:53:14 +000063/* Information about the current linux thread */
64struct vm86_saved_state {
65 uint32_t eax; /* return code */
66 uint32_t ebx;
67 uint32_t ecx;
68 uint32_t edx;
69 uint32_t esi;
70 uint32_t edi;
71 uint32_t ebp;
72 uint32_t esp;
73 uint32_t eflags;
74 uint32_t eip;
75 uint16_t cs, ss, ds, es, fs, gs;
76};
bellardb346ff42003-06-15 20:05:50 +000077#endif
bellard851e67a2003-03-29 16:53:14 +000078
Peter Maydell848d72c2013-09-03 20:12:17 +010079#if defined(TARGET_ARM) && defined(TARGET_ABI32)
bellard28c4f362004-02-16 21:47:43 +000080/* FPU emulator */
81#include "nwfpe/fpa11.h"
bellard28c4f362004-02-16 21:47:43 +000082#endif
83
pbrook624f7972008-05-31 16:11:38 +000084#define MAX_SIGQUEUE_SIZE 1024
85
pbrook624f7972008-05-31 16:11:38 +000086struct emulated_sigtable {
87 int pending; /* true if signal is pending */
Timothy E Baldwin907f5fd2016-05-27 15:51:52 +010088 target_siginfo_t info;
pbrook624f7972008-05-31 16:11:38 +000089};
90
bellard851e67a2003-03-29 16:53:14 +000091/* NOTE: we force a big alignment so that the stack stored after is
92 aligned too */
93typedef struct TaskState {
Mika Westerbergedf8e2a2009-04-07 09:57:11 +030094 pid_t ts_tid; /* tid (or pid) of this task */
bellard28c4f362004-02-16 21:47:43 +000095#ifdef TARGET_ARM
Peter Maydell848d72c2013-09-03 20:12:17 +010096# ifdef TARGET_ABI32
bellard28c4f362004-02-16 21:47:43 +000097 /* FPA state */
98 FPA11 fpa;
Peter Maydell848d72c2013-09-03 20:12:17 +010099# endif
bellarda4f81972005-04-23 18:25:41 +0000100 int swi_errno;
bellard28c4f362004-02-16 21:47:43 +0000101#endif
Guan Xuetaod2fbca92011-04-12 16:27:03 +0800102#ifdef TARGET_UNICORE32
103 int swi_errno;
104#endif
j_mayer84409dd2007-04-06 08:56:50 +0000105#if defined(TARGET_I386) && !defined(TARGET_X86_64)
blueswir1992f48a2007-10-14 16:27:31 +0000106 abi_ulong target_v86;
bellard851e67a2003-03-29 16:53:14 +0000107 struct vm86_saved_state vm86_saved_regs;
bellardb333af02003-05-14 21:48:51 +0000108 struct target_vm86plus_struct vm86plus;
bellard631271d2003-05-10 13:14:52 +0000109 uint32_t v86flags;
110 uint32_t v86mask;
bellardb346ff42003-06-15 20:05:50 +0000111#endif
pbrookc2764712009-03-07 15:24:59 +0000112 abi_ulong child_tidptr;
pbrooke6e59062006-10-22 00:18:54 +0000113#ifdef TARGET_M68K
114 int sim_syscalls;
Peter Maydell1ccd9372013-07-16 18:44:55 +0100115 abi_ulong tp_value;
pbrooke6e59062006-10-22 00:18:54 +0000116#endif
Guan Xuetaod2fbca92011-04-12 16:27:03 +0800117#if defined(TARGET_ARM) || defined(TARGET_M68K) || defined(TARGET_UNICORE32)
pbrooka87295e2007-05-26 15:09:38 +0000118 /* Extra fields for semihosted binaries. */
Peter Maydelld3170912016-07-04 13:06:35 +0100119 abi_ulong heap_base;
120 abi_ulong heap_limit;
pbrooka87295e2007-05-26 15:09:38 +0000121#endif
Peter Maydelld3170912016-07-04 13:06:35 +0100122 abi_ulong stack_base;
bellard851e67a2003-03-29 16:53:14 +0000123 int used; /* non zero if used */
pbrook978efd62006-06-17 18:30:42 +0000124 struct image_info *info;
Mika Westerbergedf8e2a2009-04-07 09:57:11 +0300125 struct linux_binprm *bprm;
pbrook624f7972008-05-31 16:11:38 +0000126
Timothy E Baldwin655ed672016-05-27 15:51:53 +0100127 struct emulated_sigtable sync_signal;
pbrook624f7972008-05-31 16:11:38 +0000128 struct emulated_sigtable sigtab[TARGET_NSIG];
Peter Maydell3d3efba2016-05-27 15:51:49 +0100129 /* This thread's signal mask, as requested by the guest program.
130 * The actual signal mask of this thread may differ:
131 * + we don't let SIGSEGV and SIGBUS be blocked while running guest code
132 * + sometimes we block all signals to avoid races
133 */
134 sigset_t signal_mask;
135 /* The signal mask imposed by a guest sigsuspend syscall, if we are
136 * currently in the middle of such a syscall
137 */
138 sigset_t sigsuspend_mask;
139 /* Nonzero if we're leaving a sigsuspend and sigsuspend_mask is valid. */
140 int in_sigsuspend;
141
142 /* Nonzero if process_pending_signals() needs to do something (either
143 * handle a pending signal or unblock signals).
144 * This flag is written from a signal handler so should be accessed via
145 * the atomic_read() and atomic_write() functions. (It is not accessed
146 * from multiple threads.)
147 */
148 int signal_pending;
149
bellard851e67a2003-03-29 16:53:14 +0000150} __attribute__((aligned(16))) TaskState;
151
aurel32d088d662009-01-30 20:09:01 +0000152extern char *exec_path;
pbrook624f7972008-05-31 16:11:38 +0000153void init_task_state(TaskState *ts);
Mika Westerbergedf8e2a2009-04-07 09:57:11 +0300154void task_settid(TaskState *);
155void stop_all_tasks(void);
pbrookc5937222006-05-14 11:30:38 +0000156extern const char *qemu_uname_release;
Paul Brook379f6692009-07-17 12:48:08 +0100157extern unsigned long mmap_min_addr;
bellard851e67a2003-03-29 16:53:14 +0000158
pbrooke5fe0c52006-06-11 13:32:59 +0000159/* ??? See if we can avoid exposing so much of the loader internals. */
pbrooke5fe0c52006-06-11 13:32:59 +0000160
Richard Henderson9955ffa2010-07-27 10:25:30 -0700161/* Read a good amount of data initially, to hopefully get all the
162 program headers loaded. */
163#define BPRM_BUF_SIZE 1024
164
pbrooke5fe0c52006-06-11 13:32:59 +0000165/*
ths5fafdf22007-09-16 21:08:06 +0000166 * This structure is used to hold the arguments that are
pbrooke5fe0c52006-06-11 13:32:59 +0000167 * used when loading binaries.
168 */
169struct linux_binprm {
Richard Henderson9955ffa2010-07-27 10:25:30 -0700170 char buf[BPRM_BUF_SIZE] __attribute__((aligned));
blueswir1992f48a2007-10-14 16:27:31 +0000171 abi_ulong p;
pbrooke5fe0c52006-06-11 13:32:59 +0000172 int fd;
173 int e_uid, e_gid;
174 int argc, envc;
175 char **argv;
176 char **envp;
177 char * filename; /* Name of binary */
Andreas Färber9349b4f2012-03-14 01:38:32 +0100178 int (*core_dump)(int, const CPUArchState *); /* coredump routine */
pbrooke5fe0c52006-06-11 13:32:59 +0000179};
180
181void do_init_thread(struct target_pt_regs *regs, struct image_info *infop);
blueswir1992f48a2007-10-14 16:27:31 +0000182abi_ulong loader_build_argptr(int envc, int argc, abi_ulong sp,
183 abi_ulong stringp, int push_ptr);
Laurent Vivier03cfd8f2013-08-30 01:46:44 +0200184int loader_exec(int fdexec, const char *filename, char **argv, char **envp,
Mika Westerbergedf8e2a2009-04-07 09:57:11 +0300185 struct target_pt_regs * regs, struct image_info *infop,
186 struct linux_binprm *);
bellard31e31b82003-02-18 22:55:36 +0000187
Will Newtonf0116c52014-01-09 09:10:50 +0000188int load_elf_binary(struct linux_binprm *bprm, struct image_info *info);
189int load_flt_binary(struct linux_binprm *bprm, struct image_info *info);
pbrooke5fe0c52006-06-11 13:32:59 +0000190
bellard579a97f2007-11-11 14:26:47 +0000191abi_long memcpy_to_target(abi_ulong dest, const void *src,
192 unsigned long len);
blueswir1992f48a2007-10-14 16:27:31 +0000193void target_set_brk(abi_ulong new_brk);
194abi_long do_brk(abi_ulong new_brk);
bellard31e31b82003-02-18 22:55:36 +0000195void syscall_init(void);
blueswir1992f48a2007-10-14 16:27:31 +0000196abi_long do_syscall(void *cpu_env, int num, abi_long arg1,
197 abi_long arg2, abi_long arg3, abi_long arg4,
Peter Maydell5945cfc2011-06-16 17:37:13 +0100198 abi_long arg5, abi_long arg6, abi_long arg7,
199 abi_long arg8);
Stefan Weile5924d82010-09-23 21:28:03 +0200200void gemu_log(const char *fmt, ...) GCC_FMT_ATTR(1, 2);
Andreas Färbera2247f82013-06-09 19:47:04 +0200201extern THREAD CPUState *thread_cpu;
Andreas Färber9349b4f2012-03-14 01:38:32 +0100202void cpu_loop(CPUArchState *env);
Peter Maydell7dcdaea2016-06-06 19:58:18 +0100203const char *target_strerror(int err);
pbrooka745ec62008-05-06 15:36:17 +0000204int get_osversion(void);
Peter Maydell4a24a752013-09-03 20:12:20 +0100205void init_qemu_uname_release(void);
pbrookd5975362008-06-07 20:50:51 +0000206void fork_start(void);
207void fork_end(int child);
bellard6977fbf2003-04-29 20:39:23 +0000208
Meador Ingedce10402012-07-26 16:50:01 +0000209/* Creates the initial guest address space in the host memory space using
210 * the given host start address hint and size. The guest_start parameter
211 * specifies the start address of the guest space. guest_base will be the
212 * difference between the host start address computed by this function and
213 * guest_start. If fixed is specified, then the mapped address space must
214 * start at host_start. The real start address of the mapped memory space is
215 * returned or -1 if there was an error.
216 */
217unsigned long init_guest_space(unsigned long host_start,
218 unsigned long host_size,
219 unsigned long guest_start,
220 bool fixed);
221
Paolo Bonzini1de7afc2012-12-17 18:20:00 +0100222#include "qemu/log.h"
bellard631271d2003-05-10 13:14:52 +0000223
Timothy E Baldwin4d330ce2016-05-12 18:47:46 +0100224/* safe_syscall.S */
225
226/**
227 * safe_syscall:
228 * @int number: number of system call to make
229 * ...: arguments to the system call
230 *
231 * Call a system call if guest signal not pending.
232 * This has the same API as the libc syscall() function, except that it
233 * may return -1 with errno == TARGET_ERESTARTSYS if a signal was pending.
234 *
235 * Returns: the system call result, or -1 with an error code in errno
236 * (Errnos are host errnos; we rely on TARGET_ERESTARTSYS not clashing
237 * with any of the host errno values.)
238 */
239
240/* A guide to using safe_syscall() to handle interactions between guest
241 * syscalls and guest signals:
242 *
243 * Guest syscalls come in two flavours:
244 *
245 * (1) Non-interruptible syscalls
246 *
247 * These are guest syscalls that never get interrupted by signals and
248 * so never return EINTR. They can be implemented straightforwardly in
249 * QEMU: just make sure that if the implementation code has to make any
250 * blocking calls that those calls are retried if they return EINTR.
251 * It's also OK to implement these with safe_syscall, though it will be
252 * a little less efficient if a signal is delivered at the 'wrong' moment.
253 *
Peter Maydell3d3efba2016-05-27 15:51:49 +0100254 * Some non-interruptible syscalls need to be handled using block_signals()
255 * to block signals for the duration of the syscall. This mainly applies
256 * to code which needs to modify the data structures used by the
257 * host_signal_handler() function and the functions it calls, including
258 * all syscalls which change the thread's signal mask.
259 *
Timothy E Baldwin4d330ce2016-05-12 18:47:46 +0100260 * (2) Interruptible syscalls
261 *
262 * These are guest syscalls that can be interrupted by signals and
263 * for which we need to either return EINTR or arrange for the guest
264 * syscall to be restarted. This category includes both syscalls which
265 * always restart (and in the kernel return -ERESTARTNOINTR), ones
266 * which only restart if there is no handler (kernel returns -ERESTARTNOHAND
267 * or -ERESTART_RESTARTBLOCK), and the most common kind which restart
268 * if the handler was registered with SA_RESTART (kernel returns
269 * -ERESTARTSYS). System calls which are only interruptible in some
270 * situations (like 'open') also need to be handled this way.
271 *
272 * Here it is important that the host syscall is made
273 * via this safe_syscall() function, and *not* via the host libc.
274 * If the host libc is used then the implementation will appear to work
275 * most of the time, but there will be a race condition where a
276 * signal could arrive just before we make the host syscall inside libc,
277 * and then then guest syscall will not correctly be interrupted.
278 * Instead the implementation of the guest syscall can use the safe_syscall
279 * function but otherwise just return the result or errno in the usual
280 * way; the main loop code will take care of restarting the syscall
281 * if appropriate.
282 *
283 * (If the implementation needs to make multiple host syscalls this is
284 * OK; any which might really block must be via safe_syscall(); for those
285 * which are only technically blocking (ie which we know in practice won't
286 * stay in the host kernel indefinitely) it's OK to use libc if necessary.
287 * You must be able to cope with backing out correctly if some safe_syscall
288 * you make in the implementation returns either -TARGET_ERESTARTSYS or
289 * EINTR though.)
290 *
Peter Maydell3d3efba2016-05-27 15:51:49 +0100291 * block_signals() cannot be used for interruptible syscalls.
292 *
Timothy E Baldwin4d330ce2016-05-12 18:47:46 +0100293 *
294 * How and why the safe_syscall implementation works:
295 *
296 * The basic setup is that we make the host syscall via a known
297 * section of host native assembly. If a signal occurs, our signal
298 * handler checks the interrupted host PC against the addresse of that
299 * known section. If the PC is before or at the address of the syscall
300 * instruction then we change the PC to point at a "return
301 * -TARGET_ERESTARTSYS" code path instead, and then exit the signal handler
302 * (causing the safe_syscall() call to immediately return that value).
303 * Then in the main.c loop if we see this magic return value we adjust
304 * the guest PC to wind it back to before the system call, and invoke
305 * the guest signal handler as usual.
306 *
307 * This winding-back will happen in two cases:
308 * (1) signal came in just before we took the host syscall (a race);
309 * in this case we'll take the guest signal and have another go
310 * at the syscall afterwards, and this is indistinguishable for the
311 * guest from the timing having been different such that the guest
312 * signal really did win the race
313 * (2) signal came in while the host syscall was blocking, and the
314 * host kernel decided the syscall should be restarted;
315 * in this case we want to restart the guest syscall also, and so
316 * rewinding is the right thing. (Note that "restart" semantics mean
317 * "first call the signal handler, then reattempt the syscall".)
318 * The other situation to consider is when a signal came in while the
319 * host syscall was blocking, and the host kernel decided that the syscall
320 * should not be restarted; in this case QEMU's host signal handler will
321 * be invoked with the PC pointing just after the syscall instruction,
322 * with registers indicating an EINTR return; the special code in the
323 * handler will not kick in, and we will return EINTR to the guest as
324 * we should.
325 *
326 * Notice that we can leave the host kernel to make the decision for
327 * us about whether to do a restart of the syscall or not; we do not
328 * need to check SA_RESTART flags in QEMU or distinguish the various
329 * kinds of restartability.
330 */
331#ifdef HAVE_SAFE_SYSCALL
332/* The core part of this function is implemented in assembly */
333extern long safe_syscall_base(int *pending, long number, ...);
334
335#define safe_syscall(...) \
336 ({ \
337 long ret_; \
338 int *psp_ = &((TaskState *)thread_cpu->opaque)->signal_pending; \
339 ret_ = safe_syscall_base(psp_, __VA_ARGS__); \
340 if (is_error(ret_)) { \
341 errno = -ret_; \
342 ret_ = -1; \
343 } \
344 ret_; \
345 })
346
347#else
348
349/* Fallback for architectures which don't yet provide a safe-syscall assembly
350 * fragment; note that this is racy!
351 * This should go away when all host architectures have been updated.
352 */
353#define safe_syscall syscall
354
355#endif
356
Richard Hendersona05c6402012-09-15 11:34:20 -0700357/* syscall.c */
358int host_to_target_waitstatus(int status);
359
thsb92c47c2007-11-01 00:07:38 +0000360/* strace.c */
361void print_syscall(int num,
bellardc16f9ed2007-11-11 17:23:29 +0000362 abi_long arg1, abi_long arg2, abi_long arg3,
363 abi_long arg4, abi_long arg5, abi_long arg6);
364void print_syscall_ret(int num, abi_long arg1);
Peter Maydell0cb581d2016-07-18 18:12:24 +0100365/**
366 * print_taken_signal:
367 * @target_signum: target signal being taken
368 * @tinfo: target_siginfo_t which will be passed to the guest for the signal
369 *
370 * Print strace output indicating that this signal is being taken by the guest,
371 * in a format similar to:
372 * --- SIGSEGV {si_signo=SIGSEGV, si_code=SI_KERNEL, si_addr=0} ---
373 */
374void print_taken_signal(int target_signum, const target_siginfo_t *tinfo);
thsb92c47c2007-11-01 00:07:38 +0000375extern int do_strace;
376
bellardb346ff42003-06-15 20:05:50 +0000377/* signal.c */
Andreas Färber9349b4f2012-03-14 01:38:32 +0100378void process_pending_signals(CPUArchState *cpu_env);
bellardb346ff42003-06-15 20:05:50 +0000379void signal_init(void);
Peter Maydell9d2803f2016-07-28 16:44:46 +0100380int queue_signal(CPUArchState *env, int sig, int si_type,
381 target_siginfo_t *info);
Anthony Liguoric227f092009-10-01 16:12:16 -0500382void host_to_target_siginfo(target_siginfo_t *tinfo, const siginfo_t *info);
383void target_to_host_siginfo(siginfo_t *info, const target_siginfo_t *tinfo);
pbrook4cb05962008-05-30 18:05:19 +0000384int target_to_host_signal(int sig);
pbrook1d9d8b52009-04-16 15:17:02 +0000385int host_to_target_signal(int sig);
Andreas Färber9349b4f2012-03-14 01:38:32 +0100386long do_sigreturn(CPUArchState *env);
387long do_rt_sigreturn(CPUArchState *env);
bellard579a97f2007-11-11 14:26:47 +0000388abi_long do_sigaltstack(abi_ulong uss_addr, abi_ulong uoss_addr, abi_ulong sp);
Alex Barcelo1c275922014-03-14 14:36:55 +0000389int do_sigprocmask(int how, const sigset_t *set, sigset_t *oldset);
Peter Maydell3d3efba2016-05-27 15:51:49 +0100390/**
391 * block_signals: block all signals while handling this guest syscall
392 *
393 * Block all signals, and arrange that the signal mask is returned to
394 * its correct value for the guest before we resume execution of guest code.
395 * If this function returns non-zero, then the caller should immediately
396 * return -TARGET_ERESTARTSYS to the main loop, which will take the pending
397 * signal and restart execution of the syscall.
398 * If block_signals() returns zero, then the caller can continue with
399 * emulation of the system call knowing that no signals can be taken
400 * (and therefore that no race conditions will result).
401 * This should only be called once, because if it is called a second time
402 * it will always return non-zero. (Think of it like a mutex that can't
403 * be recursively locked.)
404 * Signals will be unblocked again by process_pending_signals().
405 *
406 * Return value: non-zero if there was a pending signal, zero if not.
407 */
408int block_signals(void); /* Returns non zero if signal pending */
bellardb346ff42003-06-15 20:05:50 +0000409
410#ifdef TARGET_I386
bellard631271d2003-05-10 13:14:52 +0000411/* vm86.c */
412void save_v86_state(CPUX86State *env);
bellard447db212003-05-10 15:10:36 +0000413void handle_vm86_trap(CPUX86State *env, int trapno);
bellard631271d2003-05-10 13:14:52 +0000414void handle_vm86_fault(CPUX86State *env);
blueswir1992f48a2007-10-14 16:27:31 +0000415int do_vm86(CPUX86State *env, long subfunction, abi_ulong v86_addr);
blueswir15bfb56b2007-10-05 17:01:51 +0000416#elif defined(TARGET_SPARC64)
417void sparc64_set_context(CPUSPARCState *env);
418void sparc64_get_context(CPUSPARCState *env);
bellardb346ff42003-06-15 20:05:50 +0000419#endif
bellard631271d2003-05-10 13:14:52 +0000420
bellard54936002003-05-13 00:25:15 +0000421/* mmap.c */
blueswir1992f48a2007-10-14 16:27:31 +0000422int target_mprotect(abi_ulong start, abi_ulong len, int prot);
423abi_long target_mmap(abi_ulong start, abi_ulong len, int prot,
424 int flags, int fd, abi_ulong offset);
425int target_munmap(abi_ulong start, abi_ulong len);
426abi_long target_mremap(abi_ulong old_addr, abi_ulong old_size,
427 abi_ulong new_size, unsigned long flags,
428 abi_ulong new_addr);
429int target_msync(abi_ulong start, abi_ulong len, int flags);
pbrook07765902008-05-31 16:33:53 +0000430extern unsigned long last_brk;
Peter Maydell59e9d912012-03-08 14:40:33 +0000431extern abi_ulong mmap_next_start;
Riku Voipio9ad197d2009-04-21 17:23:23 +0300432abi_ulong mmap_find_vma(abi_ulong, abi_ulong);
pbrookd5975362008-06-07 20:50:51 +0000433void mmap_fork_start(void);
434void mmap_fork_end(int child);
bellard54936002003-05-13 00:25:15 +0000435
blueswir1440c7e82008-10-05 11:05:14 +0000436/* main.c */
Richard Henderson703e0e82010-03-19 14:21:13 -0700437extern unsigned long guest_stack_size;
blueswir1440c7e82008-10-05 11:05:14 +0000438
bellardedf779f2004-02-22 13:40:13 +0000439/* user access */
440
441#define VERIFY_READ 0
bellard579a97f2007-11-11 14:26:47 +0000442#define VERIFY_WRITE 1 /* implies read access */
bellardedf779f2004-02-22 13:40:13 +0000443
bellarddae32702007-11-14 10:51:00 +0000444static inline int access_ok(int type, abi_ulong addr, abi_ulong size)
445{
446 return page_check_range((target_ulong)addr, size,
447 (type == VERIFY_READ) ? PAGE_READ : (PAGE_READ | PAGE_WRITE)) == 0;
448}
bellardedf779f2004-02-22 13:40:13 +0000449
Richard Henderson658f2dc2013-01-04 16:39:31 -0800450/* NOTE __get_user and __put_user use host pointers and don't check access.
451 These are usually used to access struct data members once the struct has
452 been locked - usually with lock_user_struct. */
bellardedf779f2004-02-22 13:40:13 +0000453
Richard Henderson658f2dc2013-01-04 16:39:31 -0800454/* Tricky points:
455 - Use __builtin_choose_expr to avoid type promotion from ?:,
456 - Invalid sizes result in a compile time error stemming from
457 the fact that abort has no parameters.
458 - It's easier to use the endian-specific unaligned load/store
459 functions than host-endian unaligned load/store plus tswapN. */
460
461#define __put_user_e(x, hptr, e) \
462 (__builtin_choose_expr(sizeof(*(hptr)) == 1, stb_p, \
463 __builtin_choose_expr(sizeof(*(hptr)) == 2, stw_##e##_p, \
464 __builtin_choose_expr(sizeof(*(hptr)) == 4, stl_##e##_p, \
465 __builtin_choose_expr(sizeof(*(hptr)) == 8, stq_##e##_p, abort)))) \
Riku Voipioa42267e2014-04-22 15:40:50 +0300466 ((hptr), (x)), (void)0)
Richard Henderson658f2dc2013-01-04 16:39:31 -0800467
468#define __get_user_e(x, hptr, e) \
Peter Maydell0bc8ce92013-01-31 12:50:40 +0000469 ((x) = (typeof(*hptr))( \
Richard Henderson658f2dc2013-01-04 16:39:31 -0800470 __builtin_choose_expr(sizeof(*(hptr)) == 1, ldub_p, \
471 __builtin_choose_expr(sizeof(*(hptr)) == 2, lduw_##e##_p, \
472 __builtin_choose_expr(sizeof(*(hptr)) == 4, ldl_##e##_p, \
473 __builtin_choose_expr(sizeof(*(hptr)) == 8, ldq_##e##_p, abort)))) \
Riku Voipioa42267e2014-04-22 15:40:50 +0300474 (hptr)), (void)0)
Richard Henderson658f2dc2013-01-04 16:39:31 -0800475
476#ifdef TARGET_WORDS_BIGENDIAN
477# define __put_user(x, hptr) __put_user_e(x, hptr, be)
478# define __get_user(x, hptr) __get_user_e(x, hptr, be)
479#else
480# define __put_user(x, hptr) __put_user_e(x, hptr, le)
481# define __get_user(x, hptr) __get_user_e(x, hptr, le)
482#endif
bellardedf779f2004-02-22 13:40:13 +0000483
bellard579a97f2007-11-11 14:26:47 +0000484/* put_user()/get_user() take a guest address and check access */
485/* These are usually used to access an atomic data type, such as an int,
486 * that has been passed by address. These internally perform locking
487 * and unlocking on the data type.
488 */
489#define put_user(x, gaddr, target_type) \
490({ \
491 abi_ulong __gaddr = (gaddr); \
492 target_type *__hptr; \
Riku Voipioa42267e2014-04-22 15:40:50 +0300493 abi_long __ret = 0; \
bellard579a97f2007-11-11 14:26:47 +0000494 if ((__hptr = lock_user(VERIFY_WRITE, __gaddr, sizeof(target_type), 0))) { \
Riku Voipioa42267e2014-04-22 15:40:50 +0300495 __put_user((x), __hptr); \
bellard579a97f2007-11-11 14:26:47 +0000496 unlock_user(__hptr, __gaddr, sizeof(target_type)); \
497 } else \
498 __ret = -TARGET_EFAULT; \
499 __ret; \
bellardedf779f2004-02-22 13:40:13 +0000500})
501
bellard579a97f2007-11-11 14:26:47 +0000502#define get_user(x, gaddr, target_type) \
503({ \
504 abi_ulong __gaddr = (gaddr); \
505 target_type *__hptr; \
Riku Voipioa42267e2014-04-22 15:40:50 +0300506 abi_long __ret = 0; \
bellard579a97f2007-11-11 14:26:47 +0000507 if ((__hptr = lock_user(VERIFY_READ, __gaddr, sizeof(target_type), 1))) { \
Riku Voipioa42267e2014-04-22 15:40:50 +0300508 __get_user((x), __hptr); \
bellard579a97f2007-11-11 14:26:47 +0000509 unlock_user(__hptr, __gaddr, 0); \
bellard2f619692007-11-16 10:46:05 +0000510 } else { \
511 /* avoid warning */ \
512 (x) = 0; \
bellard579a97f2007-11-11 14:26:47 +0000513 __ret = -TARGET_EFAULT; \
bellard2f619692007-11-16 10:46:05 +0000514 } \
bellard579a97f2007-11-11 14:26:47 +0000515 __ret; \
bellardedf779f2004-02-22 13:40:13 +0000516})
517
bellard2f619692007-11-16 10:46:05 +0000518#define put_user_ual(x, gaddr) put_user((x), (gaddr), abi_ulong)
519#define put_user_sal(x, gaddr) put_user((x), (gaddr), abi_long)
520#define put_user_u64(x, gaddr) put_user((x), (gaddr), uint64_t)
521#define put_user_s64(x, gaddr) put_user((x), (gaddr), int64_t)
522#define put_user_u32(x, gaddr) put_user((x), (gaddr), uint32_t)
523#define put_user_s32(x, gaddr) put_user((x), (gaddr), int32_t)
524#define put_user_u16(x, gaddr) put_user((x), (gaddr), uint16_t)
525#define put_user_s16(x, gaddr) put_user((x), (gaddr), int16_t)
526#define put_user_u8(x, gaddr) put_user((x), (gaddr), uint8_t)
527#define put_user_s8(x, gaddr) put_user((x), (gaddr), int8_t)
528
529#define get_user_ual(x, gaddr) get_user((x), (gaddr), abi_ulong)
530#define get_user_sal(x, gaddr) get_user((x), (gaddr), abi_long)
531#define get_user_u64(x, gaddr) get_user((x), (gaddr), uint64_t)
532#define get_user_s64(x, gaddr) get_user((x), (gaddr), int64_t)
533#define get_user_u32(x, gaddr) get_user((x), (gaddr), uint32_t)
534#define get_user_s32(x, gaddr) get_user((x), (gaddr), int32_t)
535#define get_user_u16(x, gaddr) get_user((x), (gaddr), uint16_t)
536#define get_user_s16(x, gaddr) get_user((x), (gaddr), int16_t)
537#define get_user_u8(x, gaddr) get_user((x), (gaddr), uint8_t)
538#define get_user_s8(x, gaddr) get_user((x), (gaddr), int8_t)
539
bellard579a97f2007-11-11 14:26:47 +0000540/* copy_from_user() and copy_to_user() are usually used to copy data
541 * buffers between the target and host. These internally perform
542 * locking/unlocking of the memory.
543 */
544abi_long copy_from_user(void *hptr, abi_ulong gaddr, size_t len);
545abi_long copy_to_user(abi_ulong gaddr, void *hptr, size_t len);
546
pbrook53a59602006-03-25 19:31:22 +0000547/* Functions for accessing guest memory. The tget and tput functions
Stefan Weil6f20f552013-09-12 19:57:15 +0200548 read/write single values, byteswapping as necessary. The lock_user function
pbrook53a59602006-03-25 19:31:22 +0000549 gets a pointer to a contiguous area of guest memory, but does not perform
Stefan Weil6f20f552013-09-12 19:57:15 +0200550 any byteswapping. lock_user may return either a pointer to the guest
pbrook53a59602006-03-25 19:31:22 +0000551 memory, or a temporary buffer. */
552
553/* Lock an area of guest memory into the host. If copy is true then the
554 host area will have the same contents as the guest. */
bellard579a97f2007-11-11 14:26:47 +0000555static inline void *lock_user(int type, abi_ulong guest_addr, long len, int copy)
bellardedf779f2004-02-22 13:40:13 +0000556{
bellard579a97f2007-11-11 14:26:47 +0000557 if (!access_ok(type, guest_addr, len))
558 return NULL;
pbrook53a59602006-03-25 19:31:22 +0000559#ifdef DEBUG_REMAP
bellard579a97f2007-11-11 14:26:47 +0000560 {
561 void *addr;
Md Haris Iqbal38e826d2016-03-24 00:02:03 +0530562 addr = g_malloc(len);
bellard579a97f2007-11-11 14:26:47 +0000563 if (copy)
564 memcpy(addr, g2h(guest_addr), len);
565 else
566 memset(addr, 0, len);
567 return addr;
568 }
pbrook53a59602006-03-25 19:31:22 +0000569#else
570 return g2h(guest_addr);
571#endif
bellardedf779f2004-02-22 13:40:13 +0000572}
573
bellard579a97f2007-11-11 14:26:47 +0000574/* Unlock an area of guest memory. The first LEN bytes must be
ths1235fc02008-06-03 19:51:57 +0000575 flushed back to guest memory. host_ptr = NULL is explicitly
bellard579a97f2007-11-11 14:26:47 +0000576 allowed and does nothing. */
577static inline void unlock_user(void *host_ptr, abi_ulong guest_addr,
blueswir1992f48a2007-10-14 16:27:31 +0000578 long len)
bellardedf779f2004-02-22 13:40:13 +0000579{
bellard579a97f2007-11-11 14:26:47 +0000580
pbrook53a59602006-03-25 19:31:22 +0000581#ifdef DEBUG_REMAP
bellard579a97f2007-11-11 14:26:47 +0000582 if (!host_ptr)
583 return;
584 if (host_ptr == g2h(guest_addr))
pbrook53a59602006-03-25 19:31:22 +0000585 return;
586 if (len > 0)
balrog06177d32007-12-24 13:47:52 +0000587 memcpy(g2h(guest_addr), host_ptr, len);
Md Haris Iqbal38e826d2016-03-24 00:02:03 +0530588 g_free(host_ptr);
pbrook53a59602006-03-25 19:31:22 +0000589#endif
bellardedf779f2004-02-22 13:40:13 +0000590}
591
bellard579a97f2007-11-11 14:26:47 +0000592/* Return the length of a string in target memory or -TARGET_EFAULT if
593 access error. */
594abi_long target_strlen(abi_ulong gaddr);
bellardedf779f2004-02-22 13:40:13 +0000595
pbrook53a59602006-03-25 19:31:22 +0000596/* Like lock_user but for null terminated strings. */
blueswir1992f48a2007-10-14 16:27:31 +0000597static inline void *lock_user_string(abi_ulong guest_addr)
pbrook53a59602006-03-25 19:31:22 +0000598{
bellard579a97f2007-11-11 14:26:47 +0000599 abi_long len;
600 len = target_strlen(guest_addr);
601 if (len < 0)
602 return NULL;
603 return lock_user(VERIFY_READ, guest_addr, (long)(len + 1), 1);
pbrook53a59602006-03-25 19:31:22 +0000604}
605
Stefan Weil41d1af42013-09-12 19:57:41 +0200606/* Helper macros for locking/unlocking a target struct. */
bellard579a97f2007-11-11 14:26:47 +0000607#define lock_user_struct(type, host_ptr, guest_addr, copy) \
608 (host_ptr = lock_user(type, guest_addr, sizeof(*host_ptr), copy))
609#define unlock_user_struct(host_ptr, guest_addr, copy) \
pbrook53a59602006-03-25 19:31:22 +0000610 unlock_user(host_ptr, guest_addr, (copy) ? sizeof(*host_ptr) : 0)
611
pbrookc8a706f2008-06-02 16:16:42 +0000612#include <pthread.h>
pbrookc8a706f2008-06-02 16:16:42 +0000613
Peter Maydelldfeab062013-07-16 18:44:52 +0100614/* Include target-specific struct and function definitions;
615 * they may need access to the target-independent structures
616 * above, so include them last.
617 */
618#include "target_cpu.h"
619#include "target_signal.h"
Petar Jovanovic55a2b162013-10-30 14:46:31 +0100620#include "target_structs.h"
Peter Maydelldfeab062013-07-16 18:44:52 +0100621
bellarde88de092005-02-07 12:35:39 +0000622#endif /* QEMU_H */