1e88de099Sbellard #ifndef QEMU_H
2e88de099Sbellard #define QEMU_H
331e31b8aSbellard
46180a181Sbellard #include "cpu.h"
5f08b6170SPaolo Bonzini #include "exec/cpu_ldst.h"
6992f48a0Sblueswir1
722879b66SPhilippe Mathieu-Daudé #include "user/abitypes.h"
8992f48a0Sblueswir1
9992f48a0Sblueswir1 #include "syscall_defs.h"
10460c579fSLluís Vilanova #include "target_syscall.h"
11*80196013SPhilippe Mathieu-Daudé #include "accel/tcg/vcpu-state.h"
1266fb9763Sbellard
13400b7f6dSPeter Maydell /*
14400b7f6dSPeter Maydell * This is the size of the host kernel's sigset_t, needed where we make
151d48fdd9SPeter Maydell * direct system calls that take a sigset_t pointer and a size.
161d48fdd9SPeter Maydell */
171d48fdd9SPeter Maydell #define SIGSET_T_SIZE (_NSIG / 8)
181d48fdd9SPeter Maydell
19400b7f6dSPeter Maydell /*
20400b7f6dSPeter Maydell * This struct is used to hold certain information about the image.
2131e31b8aSbellard * Basically, it replicates in user space what would be certain
2231e31b8aSbellard * task_struct fields in the kernel
2331e31b8aSbellard */
2431e31b8aSbellard struct image_info {
259955ffacSRichard Henderson abi_ulong load_bias;
26992f48a0Sblueswir1 abi_ulong load_addr;
27992f48a0Sblueswir1 abi_ulong start_code;
28992f48a0Sblueswir1 abi_ulong end_code;
29992f48a0Sblueswir1 abi_ulong start_data;
30992f48a0Sblueswir1 abi_ulong end_data;
31992f48a0Sblueswir1 abi_ulong brk;
32992f48a0Sblueswir1 abi_ulong start_stack;
3397374d38SPaul Brook abi_ulong stack_limit;
345d94c2ffSRichard Henderson abi_ulong vdso;
35992f48a0Sblueswir1 abi_ulong entry;
36992f48a0Sblueswir1 abi_ulong code_offset;
37992f48a0Sblueswir1 abi_ulong data_offset;
38edf8e2afSMika Westerberg abi_ulong saved_auxv;
39125b0f55SAlexander Graf abi_ulong auxv_len;
4060f1c801SRichard Henderson abi_ulong argc;
4160f1c801SRichard Henderson abi_ulong argv;
4260f1c801SRichard Henderson abi_ulong envc;
4360f1c801SRichard Henderson abi_ulong envp;
447c4ee5bcSRichard Henderson abi_ulong file_string;
45d8fd2954SPaul Brook uint32_t elf_flags;
4631e31b8aSbellard int personality;
4733143c44SLaurent Vivier abi_ulong alignment;
48872f3d04SRichard Henderson bool exec_stack;
49a99856cdSChristophe Lyon
5060f1c801SRichard Henderson /* Generic semihosting knows about these pointers. */
5160f1c801SRichard Henderson abi_ulong arg_strings; /* strings for argv */
5260f1c801SRichard Henderson abi_ulong env_strings; /* strings for envp; ends arg_strings */
5360f1c801SRichard Henderson
54a99856cdSChristophe Lyon /* The fields below are used in FDPIC mode. */
551af02e83SMike Frysinger abi_ulong loadmap_addr;
561af02e83SMike Frysinger uint16_t nsegs;
571af02e83SMike Frysinger void *loadsegs;
581af02e83SMike Frysinger abi_ulong pt_dynamic_addr;
593cb10cfaSChristophe Lyon abi_ulong interpreter_loadmap_addr;
603cb10cfaSChristophe Lyon abi_ulong interpreter_pt_dynamic_addr;
611af02e83SMike Frysinger struct image_info *other_info;
6283f990ebSRichard Henderson
6383f990ebSRichard Henderson /* For target-specific processing of NT_GNU_PROPERTY_TYPE_0. */
6483f990ebSRichard Henderson uint32_t note_flags;
6583f990ebSRichard Henderson
6674cfc704SStefan Markovic #ifdef TARGET_MIPS
6774cfc704SStefan Markovic int fp_abi;
6874cfc704SStefan Markovic int interp_fp_abi;
6974cfc704SStefan Markovic #endif
7031e31b8aSbellard };
7131e31b8aSbellard
72b346ff46Sbellard #ifdef TARGET_I386
73851e67a1Sbellard /* Information about the current linux thread */
74851e67a1Sbellard struct vm86_saved_state {
75851e67a1Sbellard uint32_t eax; /* return code */
76851e67a1Sbellard uint32_t ebx;
77851e67a1Sbellard uint32_t ecx;
78851e67a1Sbellard uint32_t edx;
79851e67a1Sbellard uint32_t esi;
80851e67a1Sbellard uint32_t edi;
81851e67a1Sbellard uint32_t ebp;
82851e67a1Sbellard uint32_t esp;
83851e67a1Sbellard uint32_t eflags;
84851e67a1Sbellard uint32_t eip;
85851e67a1Sbellard uint16_t cs, ss, ds, es, fs, gs;
86851e67a1Sbellard };
87b346ff46Sbellard #endif
88851e67a1Sbellard
89848d72cdSPeter Maydell #if defined(TARGET_ARM) && defined(TARGET_ABI32)
9028c4f361Sbellard /* FPU emulator */
9128c4f361Sbellard #include "nwfpe/fpa11.h"
9228c4f361Sbellard #endif
9328c4f361Sbellard
94624f7979Spbrook struct emulated_sigtable {
95624f7979Spbrook int pending; /* true if signal is pending */
96907f5fddSTimothy E Baldwin target_siginfo_t info;
97624f7979Spbrook };
98624f7979Spbrook
99ef932e21SPhilippe Mathieu-Daudé struct TaskState {
100edf8e2afSMika Westerberg pid_t ts_tid; /* tid (or pid) of this task */
10128c4f361Sbellard #ifdef TARGET_ARM
102848d72cdSPeter Maydell # ifdef TARGET_ABI32
10328c4f361Sbellard /* FPA state */
10428c4f361Sbellard FPA11 fpa;
105848d72cdSPeter Maydell # endif
106a10b9d93SKeith Packard #endif
107a10b9d93SKeith Packard #if defined(TARGET_ARM) || defined(TARGET_RISCV)
108a4f81979Sbellard int swi_errno;
10928c4f361Sbellard #endif
11084409ddbSj_mayer #if defined(TARGET_I386) && !defined(TARGET_X86_64)
111992f48a0Sblueswir1 abi_ulong target_v86;
112851e67a1Sbellard struct vm86_saved_state vm86_saved_regs;
113b333af06Sbellard struct target_vm86plus_struct vm86plus;
114631271d7Sbellard uint32_t v86flags;
115631271d7Sbellard uint32_t v86mask;
116b346ff46Sbellard #endif
117c2764719Spbrook abi_ulong child_tidptr;
118e6e5906bSpbrook #ifdef TARGET_M68K
1191ccd9374SPeter Maydell abi_ulong tp_value;
120e6e5906bSpbrook #endif
121a10b9d93SKeith Packard #if defined(TARGET_ARM) || defined(TARGET_M68K) || defined(TARGET_RISCV)
122a87295e8Spbrook /* Extra fields for semihosted binaries. */
123d317091dSPeter Maydell abi_ulong heap_base;
124d317091dSPeter Maydell abi_ulong heap_limit;
125a87295e8Spbrook #endif
126d317091dSPeter Maydell abi_ulong stack_base;
127851e67a1Sbellard int used; /* non zero if used */
128978efd6aSpbrook struct image_info *info;
129edf8e2afSMika Westerberg struct linux_binprm *bprm;
130624f7979Spbrook
131655ed67cSTimothy E Baldwin struct emulated_sigtable sync_signal;
132624f7979Spbrook struct emulated_sigtable sigtab[TARGET_NSIG];
133400b7f6dSPeter Maydell /*
134400b7f6dSPeter Maydell * This thread's signal mask, as requested by the guest program.
1353d3efba0SPeter Maydell * The actual signal mask of this thread may differ:
1363d3efba0SPeter Maydell * + we don't let SIGSEGV and SIGBUS be blocked while running guest code
1373d3efba0SPeter Maydell * + sometimes we block all signals to avoid races
1383d3efba0SPeter Maydell */
1393d3efba0SPeter Maydell sigset_t signal_mask;
140400b7f6dSPeter Maydell /*
141400b7f6dSPeter Maydell * The signal mask imposed by a guest sigsuspend syscall, if we are
1423d3efba0SPeter Maydell * currently in the middle of such a syscall
1433d3efba0SPeter Maydell */
1443d3efba0SPeter Maydell sigset_t sigsuspend_mask;
1453d3efba0SPeter Maydell /* Nonzero if we're leaving a sigsuspend and sigsuspend_mask is valid. */
1463d3efba0SPeter Maydell int in_sigsuspend;
1473d3efba0SPeter Maydell
148400b7f6dSPeter Maydell /*
149400b7f6dSPeter Maydell * Nonzero if process_pending_signals() needs to do something (either
1503d3efba0SPeter Maydell * handle a pending signal or unblock signals).
1513d3efba0SPeter Maydell * This flag is written from a signal handler so should be accessed via
152d73415a3SStefan Hajnoczi * the qatomic_read() and qatomic_set() functions. (It is not accessed
1533d3efba0SPeter Maydell * from multiple threads.)
1543d3efba0SPeter Maydell */
1553d3efba0SPeter Maydell int signal_pending;
1563d3efba0SPeter Maydell
1575bfce0b7SPeter Maydell /* This thread's sigaltstack, if it has one */
1585bfce0b7SPeter Maydell struct target_sigaltstack sigaltstack_used;
159eb33cdaeSCameron Esfahani
160eb33cdaeSCameron Esfahani /* Start time of task after system boot in clock ticks */
161eb33cdaeSCameron Esfahani uint64_t start_boottime;
162ef932e21SPhilippe Mathieu-Daudé };
163851e67a1Sbellard
1643b249d26SPeter Maydell abi_long do_brk(abi_ulong new_brk);
165a4dab0a0SIlya Leoshkevich int do_guest_openat(CPUArchState *cpu_env, int dirfd, const char *pathname,
16635be898eSIlya Leoshkevich int flags, mode_t mode, bool safe);
167a4dab0a0SIlya Leoshkevich ssize_t do_guest_readlink(const char *pathname, char *buf, size_t bufsiz);
168631271d7Sbellard
169edf779ffSbellard /* user access */
170edf779ffSbellard
17164d06015SThomas Weißschuh #define VERIFY_NONE 0
17268f77666SRichard Henderson #define VERIFY_READ PAGE_READ
17368f77666SRichard Henderson #define VERIFY_WRITE (PAGE_READ | PAGE_WRITE)
174edf779ffSbellard
access_ok_untagged(int type,abi_ulong addr,abi_ulong size)175c7169b02SRichard Henderson static inline bool access_ok_untagged(int type, abi_ulong addr, abi_ulong size)
176dae3270cSbellard {
177114556c5SRichard Henderson if (size == 0
17846b12f46SRichard Henderson ? !guest_addr_valid_untagged(addr)
17946b12f46SRichard Henderson : !guest_range_valid_untagged(addr, size)) {
1804feac83aSRichard Henderson return false;
1814feac83aSRichard Henderson }
182bef6f008SRichard Henderson return page_check_range((target_ulong)addr, size, type);
183dae3270cSbellard }
184edf779ffSbellard
access_ok(CPUState * cpu,int type,abi_ulong addr,abi_ulong size)185c7169b02SRichard Henderson static inline bool access_ok(CPUState *cpu, int type,
186c7169b02SRichard Henderson abi_ulong addr, abi_ulong size)
187c7169b02SRichard Henderson {
188c7169b02SRichard Henderson return access_ok_untagged(type, cpu_untagged_addr(cpu, addr), size);
189c7169b02SRichard Henderson }
190c7169b02SRichard Henderson
191658f2dc9SRichard Henderson /* NOTE __get_user and __put_user use host pointers and don't check access.
192658f2dc9SRichard Henderson These are usually used to access struct data members once the struct has
193658f2dc9SRichard Henderson been locked - usually with lock_user_struct. */
194edf779ffSbellard
195850d5e33SPeter Maydell /*
196850d5e33SPeter Maydell * Tricky points:
197850d5e33SPeter Maydell * - Use __builtin_choose_expr to avoid type promotion from ?:,
198850d5e33SPeter Maydell * - Invalid sizes result in a compile time error stemming from
199850d5e33SPeter Maydell * the fact that abort has no parameters.
200850d5e33SPeter Maydell * - It's easier to use the endian-specific unaligned load/store
201850d5e33SPeter Maydell * functions than host-endian unaligned load/store plus tswapN.
202850d5e33SPeter Maydell * - The pragmas are necessary only to silence a clang false-positive
203850d5e33SPeter Maydell * warning: see https://bugs.llvm.org/show_bug.cgi?id=39113 .
204850d5e33SPeter Maydell * - gcc has bugs in its _Pragma() support in some versions, eg
205850d5e33SPeter Maydell * https://gcc.gnu.org/bugzilla/show_bug.cgi?id=83256 -- so we only
206850d5e33SPeter Maydell * include the warning-suppression pragmas for clang
207850d5e33SPeter Maydell */
208798b8581SThomas Huth #if defined(__clang__) && __has_warning("-Waddress-of-packed-member")
209850d5e33SPeter Maydell #define PRAGMA_DISABLE_PACKED_WARNING \
210850d5e33SPeter Maydell _Pragma("GCC diagnostic push"); \
211850d5e33SPeter Maydell _Pragma("GCC diagnostic ignored \"-Waddress-of-packed-member\"")
212850d5e33SPeter Maydell
213850d5e33SPeter Maydell #define PRAGMA_REENABLE_PACKED_WARNING \
214850d5e33SPeter Maydell _Pragma("GCC diagnostic pop")
215850d5e33SPeter Maydell
216850d5e33SPeter Maydell #else
217850d5e33SPeter Maydell #define PRAGMA_DISABLE_PACKED_WARNING
218850d5e33SPeter Maydell #define PRAGMA_REENABLE_PACKED_WARNING
219850d5e33SPeter Maydell #endif
220658f2dc9SRichard Henderson
221658f2dc9SRichard Henderson #define __put_user_e(x, hptr, e) \
222850d5e33SPeter Maydell do { \
223850d5e33SPeter Maydell PRAGMA_DISABLE_PACKED_WARNING; \
224658f2dc9SRichard Henderson (__builtin_choose_expr(sizeof(*(hptr)) == 1, stb_p, \
225658f2dc9SRichard Henderson __builtin_choose_expr(sizeof(*(hptr)) == 2, stw_##e##_p, \
226658f2dc9SRichard Henderson __builtin_choose_expr(sizeof(*(hptr)) == 4, stl_##e##_p, \
227658f2dc9SRichard Henderson __builtin_choose_expr(sizeof(*(hptr)) == 8, stq_##e##_p, abort)))) \
228850d5e33SPeter Maydell ((hptr), (x)), (void)0); \
229850d5e33SPeter Maydell PRAGMA_REENABLE_PACKED_WARNING; \
230850d5e33SPeter Maydell } while (0)
231658f2dc9SRichard Henderson
232658f2dc9SRichard Henderson #define __get_user_e(x, hptr, e) \
233850d5e33SPeter Maydell do { \
234850d5e33SPeter Maydell PRAGMA_DISABLE_PACKED_WARNING; \
2350bc8ce94SPeter Maydell ((x) = (typeof(*hptr))( \
236658f2dc9SRichard Henderson __builtin_choose_expr(sizeof(*(hptr)) == 1, ldub_p, \
237658f2dc9SRichard Henderson __builtin_choose_expr(sizeof(*(hptr)) == 2, lduw_##e##_p, \
238658f2dc9SRichard Henderson __builtin_choose_expr(sizeof(*(hptr)) == 4, ldl_##e##_p, \
239658f2dc9SRichard Henderson __builtin_choose_expr(sizeof(*(hptr)) == 8, ldq_##e##_p, abort)))) \
240850d5e33SPeter Maydell (hptr)), (void)0); \
241850d5e33SPeter Maydell PRAGMA_REENABLE_PACKED_WARNING; \
242850d5e33SPeter Maydell } while (0)
243850d5e33SPeter Maydell
244658f2dc9SRichard Henderson
245ee3eb3a7SMarc-André Lureau #if TARGET_BIG_ENDIAN
246658f2dc9SRichard Henderson # define __put_user(x, hptr) __put_user_e(x, hptr, be)
247658f2dc9SRichard Henderson # define __get_user(x, hptr) __get_user_e(x, hptr, be)
248658f2dc9SRichard Henderson #else
249658f2dc9SRichard Henderson # define __put_user(x, hptr) __put_user_e(x, hptr, le)
250658f2dc9SRichard Henderson # define __get_user(x, hptr) __get_user_e(x, hptr, le)
251658f2dc9SRichard Henderson #endif
252edf779ffSbellard
253579a97f7Sbellard /* put_user()/get_user() take a guest address and check access */
254579a97f7Sbellard /* These are usually used to access an atomic data type, such as an int,
255579a97f7Sbellard * that has been passed by address. These internally perform locking
256579a97f7Sbellard * and unlocking on the data type.
257579a97f7Sbellard */
258579a97f7Sbellard #define put_user(x, gaddr, target_type) \
259edf779ffSbellard ({ \
260579a97f7Sbellard abi_ulong __gaddr = (gaddr); \
261579a97f7Sbellard target_type *__hptr; \
262a42267efSRiku Voipio abi_long __ret = 0; \
263579a97f7Sbellard if ((__hptr = lock_user(VERIFY_WRITE, __gaddr, sizeof(target_type), 0))) { \
264a42267efSRiku Voipio __put_user((x), __hptr); \
265579a97f7Sbellard unlock_user(__hptr, __gaddr, sizeof(target_type)); \
266579a97f7Sbellard } else \
267579a97f7Sbellard __ret = -TARGET_EFAULT; \
268edf779ffSbellard __ret; \
269edf779ffSbellard })
270edf779ffSbellard
271579a97f7Sbellard #define get_user(x, gaddr, target_type) \
272edf779ffSbellard ({ \
273579a97f7Sbellard abi_ulong __gaddr = (gaddr); \
274579a97f7Sbellard target_type *__hptr; \
275a42267efSRiku Voipio abi_long __ret = 0; \
276579a97f7Sbellard if ((__hptr = lock_user(VERIFY_READ, __gaddr, sizeof(target_type), 1))) { \
277a42267efSRiku Voipio __get_user((x), __hptr); \
278579a97f7Sbellard unlock_user(__hptr, __gaddr, 0); \
2792f619698Sbellard } else { \
2802f619698Sbellard /* avoid warning */ \
2812f619698Sbellard (x) = 0; \
282579a97f7Sbellard __ret = -TARGET_EFAULT; \
2832f619698Sbellard } \
284edf779ffSbellard __ret; \
285edf779ffSbellard })
286edf779ffSbellard
2872f619698Sbellard #define put_user_ual(x, gaddr) put_user((x), (gaddr), abi_ulong)
2882f619698Sbellard #define put_user_sal(x, gaddr) put_user((x), (gaddr), abi_long)
2892f619698Sbellard #define put_user_u64(x, gaddr) put_user((x), (gaddr), uint64_t)
2902f619698Sbellard #define put_user_s64(x, gaddr) put_user((x), (gaddr), int64_t)
2912f619698Sbellard #define put_user_u32(x, gaddr) put_user((x), (gaddr), uint32_t)
2922f619698Sbellard #define put_user_s32(x, gaddr) put_user((x), (gaddr), int32_t)
2932f619698Sbellard #define put_user_u16(x, gaddr) put_user((x), (gaddr), uint16_t)
2942f619698Sbellard #define put_user_s16(x, gaddr) put_user((x), (gaddr), int16_t)
2952f619698Sbellard #define put_user_u8(x, gaddr) put_user((x), (gaddr), uint8_t)
2962f619698Sbellard #define put_user_s8(x, gaddr) put_user((x), (gaddr), int8_t)
2972f619698Sbellard
2982f619698Sbellard #define get_user_ual(x, gaddr) get_user((x), (gaddr), abi_ulong)
2992f619698Sbellard #define get_user_sal(x, gaddr) get_user((x), (gaddr), abi_long)
3002f619698Sbellard #define get_user_u64(x, gaddr) get_user((x), (gaddr), uint64_t)
3012f619698Sbellard #define get_user_s64(x, gaddr) get_user((x), (gaddr), int64_t)
3022f619698Sbellard #define get_user_u32(x, gaddr) get_user((x), (gaddr), uint32_t)
3032f619698Sbellard #define get_user_s32(x, gaddr) get_user((x), (gaddr), int32_t)
3042f619698Sbellard #define get_user_u16(x, gaddr) get_user((x), (gaddr), uint16_t)
3052f619698Sbellard #define get_user_s16(x, gaddr) get_user((x), (gaddr), int16_t)
3062f619698Sbellard #define get_user_u8(x, gaddr) get_user((x), (gaddr), uint8_t)
3072f619698Sbellard #define get_user_s8(x, gaddr) get_user((x), (gaddr), int8_t)
3082f619698Sbellard
309579a97f7Sbellard /* copy_from_user() and copy_to_user() are usually used to copy data
310579a97f7Sbellard * buffers between the target and host. These internally perform
311579a97f7Sbellard * locking/unlocking of the memory.
312579a97f7Sbellard */
313360f0abdSRichard Henderson int copy_from_user(void *hptr, abi_ulong gaddr, ssize_t len);
314360f0abdSRichard Henderson int copy_to_user(abi_ulong gaddr, void *hptr, ssize_t len);
315579a97f7Sbellard
31653a5960aSpbrook /* Functions for accessing guest memory. The tget and tput functions
3176f20f55bSStefan Weil read/write single values, byteswapping as necessary. The lock_user function
31853a5960aSpbrook gets a pointer to a contiguous area of guest memory, but does not perform
3196f20f55bSStefan Weil any byteswapping. lock_user may return either a pointer to the guest
32053a5960aSpbrook memory, or a temporary buffer. */
32153a5960aSpbrook
32253a5960aSpbrook /* Lock an area of guest memory into the host. If copy is true then the
32353a5960aSpbrook host area will have the same contents as the guest. */
324360f0abdSRichard Henderson void *lock_user(int type, abi_ulong guest_addr, ssize_t len, bool copy);
325edf779ffSbellard
326579a97f7Sbellard /* Unlock an area of guest memory. The first LEN bytes must be
3271235fc06Sths flushed back to guest memory. host_ptr = NULL is explicitly
328579a97f7Sbellard allowed and does nothing. */
3291f2355f5SIlya Leoshkevich #ifndef CONFIG_DEBUG_REMAP
unlock_user(void * host_ptr,abi_ulong guest_addr,ssize_t len)330360f0abdSRichard Henderson static inline void unlock_user(void *host_ptr, abi_ulong guest_addr,
331360f0abdSRichard Henderson ssize_t len)
332360f0abdSRichard Henderson {
333360f0abdSRichard Henderson /* no-op */
334360f0abdSRichard Henderson }
335687ca797SRichard Henderson #else
336360f0abdSRichard Henderson void unlock_user(void *host_ptr, abi_ulong guest_addr, ssize_t len);
33753a5960aSpbrook #endif
338edf779ffSbellard
339579a97f7Sbellard /* Return the length of a string in target memory or -TARGET_EFAULT if
340579a97f7Sbellard access error. */
34109f679b6SRichard Henderson ssize_t target_strlen(abi_ulong gaddr);
342edf779ffSbellard
34353a5960aSpbrook /* Like lock_user but for null terminated strings. */
344687ca797SRichard Henderson void *lock_user_string(abi_ulong guest_addr);
34553a5960aSpbrook
34641d1af4dSStefan Weil /* Helper macros for locking/unlocking a target struct. */
347579a97f7Sbellard #define lock_user_struct(type, host_ptr, guest_addr, copy) \
348579a97f7Sbellard (host_ptr = lock_user(type, guest_addr, sizeof(*host_ptr), copy))
34953a5960aSpbrook #define unlock_user_struct(host_ptr, guest_addr, copy) \
35053a5960aSpbrook unlock_user(host_ptr, guest_addr, (copy) ? sizeof(*host_ptr) : 0)
35153a5960aSpbrook
352e88de099Sbellard #endif /* QEMU_H */
353