blob: 56f29c35b5abc9597270c47881118023f3f294b3 [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
bellard31e31b82003-02-18 22:55:36 +000023/* This struct is used to hold certain information about the image.
24 * Basically, it replicates in user space what would be certain
25 * task_struct fields in the kernel
26 */
27struct image_info {
Richard Henderson9955ffa2010-07-27 10:25:30 -070028 abi_ulong load_bias;
blueswir1992f48a2007-10-14 16:27:31 +000029 abi_ulong load_addr;
30 abi_ulong start_code;
31 abi_ulong end_code;
32 abi_ulong start_data;
33 abi_ulong end_data;
34 abi_ulong start_brk;
35 abi_ulong brk;
36 abi_ulong start_mmap;
blueswir1992f48a2007-10-14 16:27:31 +000037 abi_ulong start_stack;
Paul Brook97374d32010-06-16 13:03:51 +010038 abi_ulong stack_limit;
blueswir1992f48a2007-10-14 16:27:31 +000039 abi_ulong entry;
40 abi_ulong code_offset;
41 abi_ulong data_offset;
Mika Westerbergedf8e2a2009-04-07 09:57:11 +030042 abi_ulong saved_auxv;
Alexander Graf125b0f52012-01-28 21:12:14 +020043 abi_ulong auxv_len;
Mika Westerbergedf8e2a2009-04-07 09:57:11 +030044 abi_ulong arg_start;
45 abi_ulong arg_end;
Paul Brookd8fd2952012-03-30 18:02:50 +010046 uint32_t elf_flags;
bellard31e31b82003-02-18 22:55:36 +000047 int personality;
Mike Frysinger1af02e82011-02-07 01:05:50 -050048#ifdef CONFIG_USE_FDPIC
49 abi_ulong loadmap_addr;
50 uint16_t nsegs;
51 void *loadsegs;
52 abi_ulong pt_dynamic_addr;
53 struct image_info *other_info;
54#endif
bellard31e31b82003-02-18 22:55:36 +000055};
56
bellardb346ff42003-06-15 20:05:50 +000057#ifdef TARGET_I386
bellard851e67a2003-03-29 16:53:14 +000058/* Information about the current linux thread */
59struct vm86_saved_state {
60 uint32_t eax; /* return code */
61 uint32_t ebx;
62 uint32_t ecx;
63 uint32_t edx;
64 uint32_t esi;
65 uint32_t edi;
66 uint32_t ebp;
67 uint32_t esp;
68 uint32_t eflags;
69 uint32_t eip;
70 uint16_t cs, ss, ds, es, fs, gs;
71};
bellardb346ff42003-06-15 20:05:50 +000072#endif
bellard851e67a2003-03-29 16:53:14 +000073
Peter Maydell848d72c2013-09-03 20:12:17 +010074#if defined(TARGET_ARM) && defined(TARGET_ABI32)
bellard28c4f362004-02-16 21:47:43 +000075/* FPU emulator */
76#include "nwfpe/fpa11.h"
bellard28c4f362004-02-16 21:47:43 +000077#endif
78
pbrook624f7972008-05-31 16:11:38 +000079#define MAX_SIGQUEUE_SIZE 1024
80
pbrook624f7972008-05-31 16:11:38 +000081struct emulated_sigtable {
82 int pending; /* true if signal is pending */
Timothy E Baldwin907f5fd2016-05-27 15:51:52 +010083 target_siginfo_t info;
pbrook624f7972008-05-31 16:11:38 +000084};
85
bellard851e67a2003-03-29 16:53:14 +000086/* NOTE: we force a big alignment so that the stack stored after is
87 aligned too */
88typedef struct TaskState {
Mika Westerbergedf8e2a2009-04-07 09:57:11 +030089 pid_t ts_tid; /* tid (or pid) of this task */
bellard28c4f362004-02-16 21:47:43 +000090#ifdef TARGET_ARM
Peter Maydell848d72c2013-09-03 20:12:17 +010091# ifdef TARGET_ABI32
bellard28c4f362004-02-16 21:47:43 +000092 /* FPA state */
93 FPA11 fpa;
Peter Maydell848d72c2013-09-03 20:12:17 +010094# endif
bellarda4f81972005-04-23 18:25:41 +000095 int swi_errno;
bellard28c4f362004-02-16 21:47:43 +000096#endif
Guan Xuetaod2fbca92011-04-12 16:27:03 +080097#ifdef TARGET_UNICORE32
98 int swi_errno;
99#endif
j_mayer84409dd2007-04-06 08:56:50 +0000100#if defined(TARGET_I386) && !defined(TARGET_X86_64)
blueswir1992f48a2007-10-14 16:27:31 +0000101 abi_ulong target_v86;
bellard851e67a2003-03-29 16:53:14 +0000102 struct vm86_saved_state vm86_saved_regs;
bellardb333af02003-05-14 21:48:51 +0000103 struct target_vm86plus_struct vm86plus;
bellard631271d2003-05-10 13:14:52 +0000104 uint32_t v86flags;
105 uint32_t v86mask;
bellardb346ff42003-06-15 20:05:50 +0000106#endif
pbrookc2764712009-03-07 15:24:59 +0000107 abi_ulong child_tidptr;
pbrooke6e59062006-10-22 00:18:54 +0000108#ifdef TARGET_M68K
109 int sim_syscalls;
Peter Maydell1ccd9372013-07-16 18:44:55 +0100110 abi_ulong tp_value;
pbrooke6e59062006-10-22 00:18:54 +0000111#endif
Guan Xuetaod2fbca92011-04-12 16:27:03 +0800112#if defined(TARGET_ARM) || defined(TARGET_M68K) || defined(TARGET_UNICORE32)
pbrooka87295e2007-05-26 15:09:38 +0000113 /* Extra fields for semihosted binaries. */
pbrooka87295e2007-05-26 15:09:38 +0000114 uint32_t heap_base;
115 uint32_t heap_limit;
116#endif
Riku Voipiod0fd11f2012-01-28 22:00:17 +0200117 uint32_t stack_base;
bellard851e67a2003-03-29 16:53:14 +0000118 int used; /* non zero if used */
pbrook978efd62006-06-17 18:30:42 +0000119 struct image_info *info;
Mika Westerbergedf8e2a2009-04-07 09:57:11 +0300120 struct linux_binprm *bprm;
pbrook624f7972008-05-31 16:11:38 +0000121
Timothy E Baldwin655ed672016-05-27 15:51:53 +0100122 struct emulated_sigtable sync_signal;
pbrook624f7972008-05-31 16:11:38 +0000123 struct emulated_sigtable sigtab[TARGET_NSIG];
Peter Maydell3d3efba2016-05-27 15:51:49 +0100124 /* This thread's signal mask, as requested by the guest program.
125 * The actual signal mask of this thread may differ:
126 * + we don't let SIGSEGV and SIGBUS be blocked while running guest code
127 * + sometimes we block all signals to avoid races
128 */
129 sigset_t signal_mask;
130 /* The signal mask imposed by a guest sigsuspend syscall, if we are
131 * currently in the middle of such a syscall
132 */
133 sigset_t sigsuspend_mask;
134 /* Nonzero if we're leaving a sigsuspend and sigsuspend_mask is valid. */
135 int in_sigsuspend;
136
137 /* Nonzero if process_pending_signals() needs to do something (either
138 * handle a pending signal or unblock signals).
139 * This flag is written from a signal handler so should be accessed via
140 * the atomic_read() and atomic_write() functions. (It is not accessed
141 * from multiple threads.)
142 */
143 int signal_pending;
144
bellard851e67a2003-03-29 16:53:14 +0000145} __attribute__((aligned(16))) TaskState;
146
aurel32d088d662009-01-30 20:09:01 +0000147extern char *exec_path;
pbrook624f7972008-05-31 16:11:38 +0000148void init_task_state(TaskState *ts);
Mika Westerbergedf8e2a2009-04-07 09:57:11 +0300149void task_settid(TaskState *);
150void stop_all_tasks(void);
pbrookc5937222006-05-14 11:30:38 +0000151extern const char *qemu_uname_release;
Paul Brook379f6692009-07-17 12:48:08 +0100152extern unsigned long mmap_min_addr;
bellard851e67a2003-03-29 16:53:14 +0000153
pbrooke5fe0c52006-06-11 13:32:59 +0000154/* ??? See if we can avoid exposing so much of the loader internals. */
pbrooke5fe0c52006-06-11 13:32:59 +0000155
Richard Henderson9955ffa2010-07-27 10:25:30 -0700156/* Read a good amount of data initially, to hopefully get all the
157 program headers loaded. */
158#define BPRM_BUF_SIZE 1024
159
pbrooke5fe0c52006-06-11 13:32:59 +0000160/*
ths5fafdf22007-09-16 21:08:06 +0000161 * This structure is used to hold the arguments that are
pbrooke5fe0c52006-06-11 13:32:59 +0000162 * used when loading binaries.
163 */
164struct linux_binprm {
Richard Henderson9955ffa2010-07-27 10:25:30 -0700165 char buf[BPRM_BUF_SIZE] __attribute__((aligned));
blueswir1992f48a2007-10-14 16:27:31 +0000166 abi_ulong p;
pbrooke5fe0c52006-06-11 13:32:59 +0000167 int fd;
168 int e_uid, e_gid;
169 int argc, envc;
170 char **argv;
171 char **envp;
172 char * filename; /* Name of binary */
Andreas Färber9349b4f2012-03-14 01:38:32 +0100173 int (*core_dump)(int, const CPUArchState *); /* coredump routine */
pbrooke5fe0c52006-06-11 13:32:59 +0000174};
175
176void do_init_thread(struct target_pt_regs *regs, struct image_info *infop);
blueswir1992f48a2007-10-14 16:27:31 +0000177abi_ulong loader_build_argptr(int envc, int argc, abi_ulong sp,
178 abi_ulong stringp, int push_ptr);
Laurent Vivier03cfd8f2013-08-30 01:46:44 +0200179int loader_exec(int fdexec, const char *filename, char **argv, char **envp,
Mika Westerbergedf8e2a2009-04-07 09:57:11 +0300180 struct target_pt_regs * regs, struct image_info *infop,
181 struct linux_binprm *);
bellard31e31b82003-02-18 22:55:36 +0000182
Will Newtonf0116c52014-01-09 09:10:50 +0000183int load_elf_binary(struct linux_binprm *bprm, struct image_info *info);
184int load_flt_binary(struct linux_binprm *bprm, struct image_info *info);
pbrooke5fe0c52006-06-11 13:32:59 +0000185
bellard579a97f2007-11-11 14:26:47 +0000186abi_long memcpy_to_target(abi_ulong dest, const void *src,
187 unsigned long len);
blueswir1992f48a2007-10-14 16:27:31 +0000188void target_set_brk(abi_ulong new_brk);
189abi_long do_brk(abi_ulong new_brk);
bellard31e31b82003-02-18 22:55:36 +0000190void syscall_init(void);
blueswir1992f48a2007-10-14 16:27:31 +0000191abi_long do_syscall(void *cpu_env, int num, abi_long arg1,
192 abi_long arg2, abi_long arg3, abi_long arg4,
Peter Maydell5945cfc2011-06-16 17:37:13 +0100193 abi_long arg5, abi_long arg6, abi_long arg7,
194 abi_long arg8);
Stefan Weile5924d82010-09-23 21:28:03 +0200195void gemu_log(const char *fmt, ...) GCC_FMT_ATTR(1, 2);
Andreas Färbera2247f82013-06-09 19:47:04 +0200196extern THREAD CPUState *thread_cpu;
Andreas Färber9349b4f2012-03-14 01:38:32 +0100197void cpu_loop(CPUArchState *env);
Peter Maydell7dcdaea2016-06-06 19:58:18 +0100198const char *target_strerror(int err);
pbrooka745ec62008-05-06 15:36:17 +0000199int get_osversion(void);
Peter Maydell4a24a752013-09-03 20:12:20 +0100200void init_qemu_uname_release(void);
pbrookd5975362008-06-07 20:50:51 +0000201void fork_start(void);
202void fork_end(int child);
bellard6977fbf2003-04-29 20:39:23 +0000203
Meador Ingedce10402012-07-26 16:50:01 +0000204/* Creates the initial guest address space in the host memory space using
205 * the given host start address hint and size. The guest_start parameter
206 * specifies the start address of the guest space. guest_base will be the
207 * difference between the host start address computed by this function and
208 * guest_start. If fixed is specified, then the mapped address space must
209 * start at host_start. The real start address of the mapped memory space is
210 * returned or -1 if there was an error.
211 */
212unsigned long init_guest_space(unsigned long host_start,
213 unsigned long host_size,
214 unsigned long guest_start,
215 bool fixed);
216
Paolo Bonzini1de7afc2012-12-17 18:20:00 +0100217#include "qemu/log.h"
bellard631271d2003-05-10 13:14:52 +0000218
Timothy E Baldwin4d330ce2016-05-12 18:47:46 +0100219/* safe_syscall.S */
220
221/**
222 * safe_syscall:
223 * @int number: number of system call to make
224 * ...: arguments to the system call
225 *
226 * Call a system call if guest signal not pending.
227 * This has the same API as the libc syscall() function, except that it
228 * may return -1 with errno == TARGET_ERESTARTSYS if a signal was pending.
229 *
230 * Returns: the system call result, or -1 with an error code in errno
231 * (Errnos are host errnos; we rely on TARGET_ERESTARTSYS not clashing
232 * with any of the host errno values.)
233 */
234
235/* A guide to using safe_syscall() to handle interactions between guest
236 * syscalls and guest signals:
237 *
238 * Guest syscalls come in two flavours:
239 *
240 * (1) Non-interruptible syscalls
241 *
242 * These are guest syscalls that never get interrupted by signals and
243 * so never return EINTR. They can be implemented straightforwardly in
244 * QEMU: just make sure that if the implementation code has to make any
245 * blocking calls that those calls are retried if they return EINTR.
246 * It's also OK to implement these with safe_syscall, though it will be
247 * a little less efficient if a signal is delivered at the 'wrong' moment.
248 *
Peter Maydell3d3efba2016-05-27 15:51:49 +0100249 * Some non-interruptible syscalls need to be handled using block_signals()
250 * to block signals for the duration of the syscall. This mainly applies
251 * to code which needs to modify the data structures used by the
252 * host_signal_handler() function and the functions it calls, including
253 * all syscalls which change the thread's signal mask.
254 *
Timothy E Baldwin4d330ce2016-05-12 18:47:46 +0100255 * (2) Interruptible syscalls
256 *
257 * These are guest syscalls that can be interrupted by signals and
258 * for which we need to either return EINTR or arrange for the guest
259 * syscall to be restarted. This category includes both syscalls which
260 * always restart (and in the kernel return -ERESTARTNOINTR), ones
261 * which only restart if there is no handler (kernel returns -ERESTARTNOHAND
262 * or -ERESTART_RESTARTBLOCK), and the most common kind which restart
263 * if the handler was registered with SA_RESTART (kernel returns
264 * -ERESTARTSYS). System calls which are only interruptible in some
265 * situations (like 'open') also need to be handled this way.
266 *
267 * Here it is important that the host syscall is made
268 * via this safe_syscall() function, and *not* via the host libc.
269 * If the host libc is used then the implementation will appear to work
270 * most of the time, but there will be a race condition where a
271 * signal could arrive just before we make the host syscall inside libc,
272 * and then then guest syscall will not correctly be interrupted.
273 * Instead the implementation of the guest syscall can use the safe_syscall
274 * function but otherwise just return the result or errno in the usual
275 * way; the main loop code will take care of restarting the syscall
276 * if appropriate.
277 *
278 * (If the implementation needs to make multiple host syscalls this is
279 * OK; any which might really block must be via safe_syscall(); for those
280 * which are only technically blocking (ie which we know in practice won't
281 * stay in the host kernel indefinitely) it's OK to use libc if necessary.
282 * You must be able to cope with backing out correctly if some safe_syscall
283 * you make in the implementation returns either -TARGET_ERESTARTSYS or
284 * EINTR though.)
285 *
Peter Maydell3d3efba2016-05-27 15:51:49 +0100286 * block_signals() cannot be used for interruptible syscalls.
287 *
Timothy E Baldwin4d330ce2016-05-12 18:47:46 +0100288 *
289 * How and why the safe_syscall implementation works:
290 *
291 * The basic setup is that we make the host syscall via a known
292 * section of host native assembly. If a signal occurs, our signal
293 * handler checks the interrupted host PC against the addresse of that
294 * known section. If the PC is before or at the address of the syscall
295 * instruction then we change the PC to point at a "return
296 * -TARGET_ERESTARTSYS" code path instead, and then exit the signal handler
297 * (causing the safe_syscall() call to immediately return that value).
298 * Then in the main.c loop if we see this magic return value we adjust
299 * the guest PC to wind it back to before the system call, and invoke
300 * the guest signal handler as usual.
301 *
302 * This winding-back will happen in two cases:
303 * (1) signal came in just before we took the host syscall (a race);
304 * in this case we'll take the guest signal and have another go
305 * at the syscall afterwards, and this is indistinguishable for the
306 * guest from the timing having been different such that the guest
307 * signal really did win the race
308 * (2) signal came in while the host syscall was blocking, and the
309 * host kernel decided the syscall should be restarted;
310 * in this case we want to restart the guest syscall also, and so
311 * rewinding is the right thing. (Note that "restart" semantics mean
312 * "first call the signal handler, then reattempt the syscall".)
313 * The other situation to consider is when a signal came in while the
314 * host syscall was blocking, and the host kernel decided that the syscall
315 * should not be restarted; in this case QEMU's host signal handler will
316 * be invoked with the PC pointing just after the syscall instruction,
317 * with registers indicating an EINTR return; the special code in the
318 * handler will not kick in, and we will return EINTR to the guest as
319 * we should.
320 *
321 * Notice that we can leave the host kernel to make the decision for
322 * us about whether to do a restart of the syscall or not; we do not
323 * need to check SA_RESTART flags in QEMU or distinguish the various
324 * kinds of restartability.
325 */
326#ifdef HAVE_SAFE_SYSCALL
327/* The core part of this function is implemented in assembly */
328extern long safe_syscall_base(int *pending, long number, ...);
329
330#define safe_syscall(...) \
331 ({ \
332 long ret_; \
333 int *psp_ = &((TaskState *)thread_cpu->opaque)->signal_pending; \
334 ret_ = safe_syscall_base(psp_, __VA_ARGS__); \
335 if (is_error(ret_)) { \
336 errno = -ret_; \
337 ret_ = -1; \
338 } \
339 ret_; \
340 })
341
342#else
343
344/* Fallback for architectures which don't yet provide a safe-syscall assembly
345 * fragment; note that this is racy!
346 * This should go away when all host architectures have been updated.
347 */
348#define safe_syscall syscall
349
350#endif
351
Richard Hendersona05c6402012-09-15 11:34:20 -0700352/* syscall.c */
353int host_to_target_waitstatus(int status);
354
thsb92c47c2007-11-01 00:07:38 +0000355/* strace.c */
356void print_syscall(int num,
bellardc16f9ed2007-11-11 17:23:29 +0000357 abi_long arg1, abi_long arg2, abi_long arg3,
358 abi_long arg4, abi_long arg5, abi_long arg6);
359void print_syscall_ret(int num, abi_long arg1);
thsb92c47c2007-11-01 00:07:38 +0000360extern int do_strace;
361
bellardb346ff42003-06-15 20:05:50 +0000362/* signal.c */
Andreas Färber9349b4f2012-03-14 01:38:32 +0100363void process_pending_signals(CPUArchState *cpu_env);
bellardb346ff42003-06-15 20:05:50 +0000364void signal_init(void);
Andreas Färber9349b4f2012-03-14 01:38:32 +0100365int queue_signal(CPUArchState *env, int sig, target_siginfo_t *info);
Anthony Liguoric227f092009-10-01 16:12:16 -0500366void host_to_target_siginfo(target_siginfo_t *tinfo, const siginfo_t *info);
367void target_to_host_siginfo(siginfo_t *info, const target_siginfo_t *tinfo);
pbrook4cb05962008-05-30 18:05:19 +0000368int target_to_host_signal(int sig);
pbrook1d9d8b52009-04-16 15:17:02 +0000369int host_to_target_signal(int sig);
Andreas Färber9349b4f2012-03-14 01:38:32 +0100370long do_sigreturn(CPUArchState *env);
371long do_rt_sigreturn(CPUArchState *env);
bellard579a97f2007-11-11 14:26:47 +0000372abi_long do_sigaltstack(abi_ulong uss_addr, abi_ulong uoss_addr, abi_ulong sp);
Alex Barcelo1c275922014-03-14 14:36:55 +0000373int do_sigprocmask(int how, const sigset_t *set, sigset_t *oldset);
Peter Maydell3d3efba2016-05-27 15:51:49 +0100374/**
375 * block_signals: block all signals while handling this guest syscall
376 *
377 * Block all signals, and arrange that the signal mask is returned to
378 * its correct value for the guest before we resume execution of guest code.
379 * If this function returns non-zero, then the caller should immediately
380 * return -TARGET_ERESTARTSYS to the main loop, which will take the pending
381 * signal and restart execution of the syscall.
382 * If block_signals() returns zero, then the caller can continue with
383 * emulation of the system call knowing that no signals can be taken
384 * (and therefore that no race conditions will result).
385 * This should only be called once, because if it is called a second time
386 * it will always return non-zero. (Think of it like a mutex that can't
387 * be recursively locked.)
388 * Signals will be unblocked again by process_pending_signals().
389 *
390 * Return value: non-zero if there was a pending signal, zero if not.
391 */
392int block_signals(void); /* Returns non zero if signal pending */
bellardb346ff42003-06-15 20:05:50 +0000393
394#ifdef TARGET_I386
bellard631271d2003-05-10 13:14:52 +0000395/* vm86.c */
396void save_v86_state(CPUX86State *env);
bellard447db212003-05-10 15:10:36 +0000397void handle_vm86_trap(CPUX86State *env, int trapno);
bellard631271d2003-05-10 13:14:52 +0000398void handle_vm86_fault(CPUX86State *env);
blueswir1992f48a2007-10-14 16:27:31 +0000399int do_vm86(CPUX86State *env, long subfunction, abi_ulong v86_addr);
blueswir15bfb56b2007-10-05 17:01:51 +0000400#elif defined(TARGET_SPARC64)
401void sparc64_set_context(CPUSPARCState *env);
402void sparc64_get_context(CPUSPARCState *env);
bellardb346ff42003-06-15 20:05:50 +0000403#endif
bellard631271d2003-05-10 13:14:52 +0000404
bellard54936002003-05-13 00:25:15 +0000405/* mmap.c */
blueswir1992f48a2007-10-14 16:27:31 +0000406int target_mprotect(abi_ulong start, abi_ulong len, int prot);
407abi_long target_mmap(abi_ulong start, abi_ulong len, int prot,
408 int flags, int fd, abi_ulong offset);
409int target_munmap(abi_ulong start, abi_ulong len);
410abi_long target_mremap(abi_ulong old_addr, abi_ulong old_size,
411 abi_ulong new_size, unsigned long flags,
412 abi_ulong new_addr);
413int target_msync(abi_ulong start, abi_ulong len, int flags);
pbrook07765902008-05-31 16:33:53 +0000414extern unsigned long last_brk;
Peter Maydell59e9d912012-03-08 14:40:33 +0000415extern abi_ulong mmap_next_start;
Riku Voipio9ad197d2009-04-21 17:23:23 +0300416abi_ulong mmap_find_vma(abi_ulong, abi_ulong);
pbrookc2764712009-03-07 15:24:59 +0000417void cpu_list_lock(void);
418void cpu_list_unlock(void);
pbrookd5975362008-06-07 20:50:51 +0000419void mmap_fork_start(void);
420void mmap_fork_end(int child);
bellard54936002003-05-13 00:25:15 +0000421
blueswir1440c7e82008-10-05 11:05:14 +0000422/* main.c */
Richard Henderson703e0e82010-03-19 14:21:13 -0700423extern unsigned long guest_stack_size;
blueswir1440c7e82008-10-05 11:05:14 +0000424
bellardedf779f2004-02-22 13:40:13 +0000425/* user access */
426
427#define VERIFY_READ 0
bellard579a97f2007-11-11 14:26:47 +0000428#define VERIFY_WRITE 1 /* implies read access */
bellardedf779f2004-02-22 13:40:13 +0000429
bellarddae32702007-11-14 10:51:00 +0000430static inline int access_ok(int type, abi_ulong addr, abi_ulong size)
431{
432 return page_check_range((target_ulong)addr, size,
433 (type == VERIFY_READ) ? PAGE_READ : (PAGE_READ | PAGE_WRITE)) == 0;
434}
bellardedf779f2004-02-22 13:40:13 +0000435
Richard Henderson658f2dc2013-01-04 16:39:31 -0800436/* NOTE __get_user and __put_user use host pointers and don't check access.
437 These are usually used to access struct data members once the struct has
438 been locked - usually with lock_user_struct. */
bellardedf779f2004-02-22 13:40:13 +0000439
Richard Henderson658f2dc2013-01-04 16:39:31 -0800440/* Tricky points:
441 - Use __builtin_choose_expr to avoid type promotion from ?:,
442 - Invalid sizes result in a compile time error stemming from
443 the fact that abort has no parameters.
444 - It's easier to use the endian-specific unaligned load/store
445 functions than host-endian unaligned load/store plus tswapN. */
446
447#define __put_user_e(x, hptr, e) \
448 (__builtin_choose_expr(sizeof(*(hptr)) == 1, stb_p, \
449 __builtin_choose_expr(sizeof(*(hptr)) == 2, stw_##e##_p, \
450 __builtin_choose_expr(sizeof(*(hptr)) == 4, stl_##e##_p, \
451 __builtin_choose_expr(sizeof(*(hptr)) == 8, stq_##e##_p, abort)))) \
Riku Voipioa42267e2014-04-22 15:40:50 +0300452 ((hptr), (x)), (void)0)
Richard Henderson658f2dc2013-01-04 16:39:31 -0800453
454#define __get_user_e(x, hptr, e) \
Peter Maydell0bc8ce92013-01-31 12:50:40 +0000455 ((x) = (typeof(*hptr))( \
Richard Henderson658f2dc2013-01-04 16:39:31 -0800456 __builtin_choose_expr(sizeof(*(hptr)) == 1, ldub_p, \
457 __builtin_choose_expr(sizeof(*(hptr)) == 2, lduw_##e##_p, \
458 __builtin_choose_expr(sizeof(*(hptr)) == 4, ldl_##e##_p, \
459 __builtin_choose_expr(sizeof(*(hptr)) == 8, ldq_##e##_p, abort)))) \
Riku Voipioa42267e2014-04-22 15:40:50 +0300460 (hptr)), (void)0)
Richard Henderson658f2dc2013-01-04 16:39:31 -0800461
462#ifdef TARGET_WORDS_BIGENDIAN
463# define __put_user(x, hptr) __put_user_e(x, hptr, be)
464# define __get_user(x, hptr) __get_user_e(x, hptr, be)
465#else
466# define __put_user(x, hptr) __put_user_e(x, hptr, le)
467# define __get_user(x, hptr) __get_user_e(x, hptr, le)
468#endif
bellardedf779f2004-02-22 13:40:13 +0000469
bellard579a97f2007-11-11 14:26:47 +0000470/* put_user()/get_user() take a guest address and check access */
471/* These are usually used to access an atomic data type, such as an int,
472 * that has been passed by address. These internally perform locking
473 * and unlocking on the data type.
474 */
475#define put_user(x, gaddr, target_type) \
476({ \
477 abi_ulong __gaddr = (gaddr); \
478 target_type *__hptr; \
Riku Voipioa42267e2014-04-22 15:40:50 +0300479 abi_long __ret = 0; \
bellard579a97f2007-11-11 14:26:47 +0000480 if ((__hptr = lock_user(VERIFY_WRITE, __gaddr, sizeof(target_type), 0))) { \
Riku Voipioa42267e2014-04-22 15:40:50 +0300481 __put_user((x), __hptr); \
bellard579a97f2007-11-11 14:26:47 +0000482 unlock_user(__hptr, __gaddr, sizeof(target_type)); \
483 } else \
484 __ret = -TARGET_EFAULT; \
485 __ret; \
bellardedf779f2004-02-22 13:40:13 +0000486})
487
bellard579a97f2007-11-11 14:26:47 +0000488#define get_user(x, gaddr, target_type) \
489({ \
490 abi_ulong __gaddr = (gaddr); \
491 target_type *__hptr; \
Riku Voipioa42267e2014-04-22 15:40:50 +0300492 abi_long __ret = 0; \
bellard579a97f2007-11-11 14:26:47 +0000493 if ((__hptr = lock_user(VERIFY_READ, __gaddr, sizeof(target_type), 1))) { \
Riku Voipioa42267e2014-04-22 15:40:50 +0300494 __get_user((x), __hptr); \
bellard579a97f2007-11-11 14:26:47 +0000495 unlock_user(__hptr, __gaddr, 0); \
bellard2f619692007-11-16 10:46:05 +0000496 } else { \
497 /* avoid warning */ \
498 (x) = 0; \
bellard579a97f2007-11-11 14:26:47 +0000499 __ret = -TARGET_EFAULT; \
bellard2f619692007-11-16 10:46:05 +0000500 } \
bellard579a97f2007-11-11 14:26:47 +0000501 __ret; \
bellardedf779f2004-02-22 13:40:13 +0000502})
503
bellard2f619692007-11-16 10:46:05 +0000504#define put_user_ual(x, gaddr) put_user((x), (gaddr), abi_ulong)
505#define put_user_sal(x, gaddr) put_user((x), (gaddr), abi_long)
506#define put_user_u64(x, gaddr) put_user((x), (gaddr), uint64_t)
507#define put_user_s64(x, gaddr) put_user((x), (gaddr), int64_t)
508#define put_user_u32(x, gaddr) put_user((x), (gaddr), uint32_t)
509#define put_user_s32(x, gaddr) put_user((x), (gaddr), int32_t)
510#define put_user_u16(x, gaddr) put_user((x), (gaddr), uint16_t)
511#define put_user_s16(x, gaddr) put_user((x), (gaddr), int16_t)
512#define put_user_u8(x, gaddr) put_user((x), (gaddr), uint8_t)
513#define put_user_s8(x, gaddr) put_user((x), (gaddr), int8_t)
514
515#define get_user_ual(x, gaddr) get_user((x), (gaddr), abi_ulong)
516#define get_user_sal(x, gaddr) get_user((x), (gaddr), abi_long)
517#define get_user_u64(x, gaddr) get_user((x), (gaddr), uint64_t)
518#define get_user_s64(x, gaddr) get_user((x), (gaddr), int64_t)
519#define get_user_u32(x, gaddr) get_user((x), (gaddr), uint32_t)
520#define get_user_s32(x, gaddr) get_user((x), (gaddr), int32_t)
521#define get_user_u16(x, gaddr) get_user((x), (gaddr), uint16_t)
522#define get_user_s16(x, gaddr) get_user((x), (gaddr), int16_t)
523#define get_user_u8(x, gaddr) get_user((x), (gaddr), uint8_t)
524#define get_user_s8(x, gaddr) get_user((x), (gaddr), int8_t)
525
bellard579a97f2007-11-11 14:26:47 +0000526/* copy_from_user() and copy_to_user() are usually used to copy data
527 * buffers between the target and host. These internally perform
528 * locking/unlocking of the memory.
529 */
530abi_long copy_from_user(void *hptr, abi_ulong gaddr, size_t len);
531abi_long copy_to_user(abi_ulong gaddr, void *hptr, size_t len);
532
pbrook53a59602006-03-25 19:31:22 +0000533/* Functions for accessing guest memory. The tget and tput functions
Stefan Weil6f20f552013-09-12 19:57:15 +0200534 read/write single values, byteswapping as necessary. The lock_user function
pbrook53a59602006-03-25 19:31:22 +0000535 gets a pointer to a contiguous area of guest memory, but does not perform
Stefan Weil6f20f552013-09-12 19:57:15 +0200536 any byteswapping. lock_user may return either a pointer to the guest
pbrook53a59602006-03-25 19:31:22 +0000537 memory, or a temporary buffer. */
538
539/* Lock an area of guest memory into the host. If copy is true then the
540 host area will have the same contents as the guest. */
bellard579a97f2007-11-11 14:26:47 +0000541static inline void *lock_user(int type, abi_ulong guest_addr, long len, int copy)
bellardedf779f2004-02-22 13:40:13 +0000542{
bellard579a97f2007-11-11 14:26:47 +0000543 if (!access_ok(type, guest_addr, len))
544 return NULL;
pbrook53a59602006-03-25 19:31:22 +0000545#ifdef DEBUG_REMAP
bellard579a97f2007-11-11 14:26:47 +0000546 {
547 void *addr;
548 addr = malloc(len);
549 if (copy)
550 memcpy(addr, g2h(guest_addr), len);
551 else
552 memset(addr, 0, len);
553 return addr;
554 }
pbrook53a59602006-03-25 19:31:22 +0000555#else
556 return g2h(guest_addr);
557#endif
bellardedf779f2004-02-22 13:40:13 +0000558}
559
bellard579a97f2007-11-11 14:26:47 +0000560/* Unlock an area of guest memory. The first LEN bytes must be
ths1235fc02008-06-03 19:51:57 +0000561 flushed back to guest memory. host_ptr = NULL is explicitly
bellard579a97f2007-11-11 14:26:47 +0000562 allowed and does nothing. */
563static inline void unlock_user(void *host_ptr, abi_ulong guest_addr,
blueswir1992f48a2007-10-14 16:27:31 +0000564 long len)
bellardedf779f2004-02-22 13:40:13 +0000565{
bellard579a97f2007-11-11 14:26:47 +0000566
pbrook53a59602006-03-25 19:31:22 +0000567#ifdef DEBUG_REMAP
bellard579a97f2007-11-11 14:26:47 +0000568 if (!host_ptr)
569 return;
570 if (host_ptr == g2h(guest_addr))
pbrook53a59602006-03-25 19:31:22 +0000571 return;
572 if (len > 0)
balrog06177d32007-12-24 13:47:52 +0000573 memcpy(g2h(guest_addr), host_ptr, len);
bellard579a97f2007-11-11 14:26:47 +0000574 free(host_ptr);
pbrook53a59602006-03-25 19:31:22 +0000575#endif
bellardedf779f2004-02-22 13:40:13 +0000576}
577
bellard579a97f2007-11-11 14:26:47 +0000578/* Return the length of a string in target memory or -TARGET_EFAULT if
579 access error. */
580abi_long target_strlen(abi_ulong gaddr);
bellardedf779f2004-02-22 13:40:13 +0000581
pbrook53a59602006-03-25 19:31:22 +0000582/* Like lock_user but for null terminated strings. */
blueswir1992f48a2007-10-14 16:27:31 +0000583static inline void *lock_user_string(abi_ulong guest_addr)
pbrook53a59602006-03-25 19:31:22 +0000584{
bellard579a97f2007-11-11 14:26:47 +0000585 abi_long len;
586 len = target_strlen(guest_addr);
587 if (len < 0)
588 return NULL;
589 return lock_user(VERIFY_READ, guest_addr, (long)(len + 1), 1);
pbrook53a59602006-03-25 19:31:22 +0000590}
591
Stefan Weil41d1af42013-09-12 19:57:41 +0200592/* Helper macros for locking/unlocking a target struct. */
bellard579a97f2007-11-11 14:26:47 +0000593#define lock_user_struct(type, host_ptr, guest_addr, copy) \
594 (host_ptr = lock_user(type, guest_addr, sizeof(*host_ptr), copy))
595#define unlock_user_struct(host_ptr, guest_addr, copy) \
pbrook53a59602006-03-25 19:31:22 +0000596 unlock_user(host_ptr, guest_addr, (copy) ? sizeof(*host_ptr) : 0)
597
pbrookc8a706f2008-06-02 16:16:42 +0000598#include <pthread.h>
pbrookc8a706f2008-06-02 16:16:42 +0000599
Peter Maydelldfeab062013-07-16 18:44:52 +0100600/* Include target-specific struct and function definitions;
601 * they may need access to the target-independent structures
602 * above, so include them last.
603 */
604#include "target_cpu.h"
605#include "target_signal.h"
Petar Jovanovic55a2b162013-10-30 14:46:31 +0100606#include "target_structs.h"
Peter Maydelldfeab062013-07-16 18:44:52 +0100607
bellarde88de092005-02-07 12:35:39 +0000608#endif /* QEMU_H */