1e88de099Sbellard #ifndef QEMU_H
2e88de099Sbellard #define QEMU_H
331e31b8aSbellard
46180a181Sbellard #include "cpu.h"
5f08b6170SPaolo Bonzini #include "exec/cpu_ldst.h"
6992f48a0Sblueswir1
7*22879b66SPhilippe Mathieu-Daudé #include "user/abitypes.h"
8992f48a0Sblueswir1
9992f48a0Sblueswir1 #include "syscall_defs.h"
10460c579fSLluís Vilanova #include "target_syscall.h"
1166fb9763Sbellard
12400b7f6dSPeter Maydell /*
13400b7f6dSPeter Maydell * This is the size of the host kernel's sigset_t, needed where we make
141d48fdd9SPeter Maydell * direct system calls that take a sigset_t pointer and a size.
151d48fdd9SPeter Maydell */
161d48fdd9SPeter Maydell #define SIGSET_T_SIZE (_NSIG / 8)
171d48fdd9SPeter Maydell
18400b7f6dSPeter Maydell /*
19400b7f6dSPeter Maydell * This struct is used to hold certain information about the image.
2031e31b8aSbellard * Basically, it replicates in user space what would be certain
2131e31b8aSbellard * task_struct fields in the kernel
2231e31b8aSbellard */
2331e31b8aSbellard struct image_info {
249955ffacSRichard Henderson abi_ulong load_bias;
25992f48a0Sblueswir1 abi_ulong load_addr;
26992f48a0Sblueswir1 abi_ulong start_code;
27992f48a0Sblueswir1 abi_ulong end_code;
28992f48a0Sblueswir1 abi_ulong start_data;
29992f48a0Sblueswir1 abi_ulong end_data;
30992f48a0Sblueswir1 abi_ulong brk;
31992f48a0Sblueswir1 abi_ulong start_stack;
3297374d38SPaul Brook abi_ulong stack_limit;
335d94c2ffSRichard Henderson abi_ulong vdso;
34992f48a0Sblueswir1 abi_ulong entry;
35992f48a0Sblueswir1 abi_ulong code_offset;
36992f48a0Sblueswir1 abi_ulong data_offset;
37edf8e2afSMika Westerberg abi_ulong saved_auxv;
38125b0f55SAlexander Graf abi_ulong auxv_len;
3960f1c801SRichard Henderson abi_ulong argc;
4060f1c801SRichard Henderson abi_ulong argv;
4160f1c801SRichard Henderson abi_ulong envc;
4260f1c801SRichard Henderson abi_ulong envp;
437c4ee5bcSRichard Henderson abi_ulong file_string;
44d8fd2954SPaul Brook uint32_t elf_flags;
4531e31b8aSbellard int personality;
4633143c44SLaurent Vivier abi_ulong alignment;
47872f3d04SRichard Henderson bool exec_stack;
48a99856cdSChristophe Lyon
4960f1c801SRichard Henderson /* Generic semihosting knows about these pointers. */
5060f1c801SRichard Henderson abi_ulong arg_strings; /* strings for argv */
5160f1c801SRichard Henderson abi_ulong env_strings; /* strings for envp; ends arg_strings */
5260f1c801SRichard Henderson
53a99856cdSChristophe Lyon /* The fields below are used in FDPIC mode. */
541af02e83SMike Frysinger abi_ulong loadmap_addr;
551af02e83SMike Frysinger uint16_t nsegs;
561af02e83SMike Frysinger void *loadsegs;
571af02e83SMike Frysinger abi_ulong pt_dynamic_addr;
583cb10cfaSChristophe Lyon abi_ulong interpreter_loadmap_addr;
593cb10cfaSChristophe Lyon abi_ulong interpreter_pt_dynamic_addr;
601af02e83SMike Frysinger struct image_info *other_info;
6183f990ebSRichard Henderson
6283f990ebSRichard Henderson /* For target-specific processing of NT_GNU_PROPERTY_TYPE_0. */
6383f990ebSRichard Henderson uint32_t note_flags;
6483f990ebSRichard Henderson
6574cfc704SStefan Markovic #ifdef TARGET_MIPS
6674cfc704SStefan Markovic int fp_abi;
6774cfc704SStefan Markovic int interp_fp_abi;
6874cfc704SStefan Markovic #endif
6931e31b8aSbellard };
7031e31b8aSbellard
71b346ff46Sbellard #ifdef TARGET_I386
72851e67a1Sbellard /* Information about the current linux thread */
73851e67a1Sbellard struct vm86_saved_state {
74851e67a1Sbellard uint32_t eax; /* return code */
75851e67a1Sbellard uint32_t ebx;
76851e67a1Sbellard uint32_t ecx;
77851e67a1Sbellard uint32_t edx;
78851e67a1Sbellard uint32_t esi;
79851e67a1Sbellard uint32_t edi;
80851e67a1Sbellard uint32_t ebp;
81851e67a1Sbellard uint32_t esp;
82851e67a1Sbellard uint32_t eflags;
83851e67a1Sbellard uint32_t eip;
84851e67a1Sbellard uint16_t cs, ss, ds, es, fs, gs;
85851e67a1Sbellard };
86b346ff46Sbellard #endif
87851e67a1Sbellard
88848d72cdSPeter Maydell #if defined(TARGET_ARM) && defined(TARGET_ABI32)
8928c4f361Sbellard /* FPU emulator */
9028c4f361Sbellard #include "nwfpe/fpa11.h"
9128c4f361Sbellard #endif
9228c4f361Sbellard
93624f7979Spbrook struct emulated_sigtable {
94624f7979Spbrook int pending; /* true if signal is pending */
95907f5fddSTimothy E Baldwin target_siginfo_t info;
96624f7979Spbrook };
97624f7979Spbrook
98851e67a1Sbellard typedef struct TaskState {
99edf8e2afSMika Westerberg pid_t ts_tid; /* tid (or pid) of this task */
10028c4f361Sbellard #ifdef TARGET_ARM
101848d72cdSPeter Maydell # ifdef TARGET_ABI32
10228c4f361Sbellard /* FPA state */
10328c4f361Sbellard FPA11 fpa;
104848d72cdSPeter Maydell # endif
105a10b9d93SKeith Packard #endif
106a10b9d93SKeith Packard #if defined(TARGET_ARM) || defined(TARGET_RISCV)
107a4f81979Sbellard int swi_errno;
10828c4f361Sbellard #endif
10984409ddbSj_mayer #if defined(TARGET_I386) && !defined(TARGET_X86_64)
110992f48a0Sblueswir1 abi_ulong target_v86;
111851e67a1Sbellard struct vm86_saved_state vm86_saved_regs;
112b333af06Sbellard struct target_vm86plus_struct vm86plus;
113631271d7Sbellard uint32_t v86flags;
114631271d7Sbellard uint32_t v86mask;
115b346ff46Sbellard #endif
116c2764719Spbrook abi_ulong child_tidptr;
117e6e5906bSpbrook #ifdef TARGET_M68K
1181ccd9374SPeter Maydell abi_ulong tp_value;
119e6e5906bSpbrook #endif
120a10b9d93SKeith Packard #if defined(TARGET_ARM) || defined(TARGET_M68K) || defined(TARGET_RISCV)
121a87295e8Spbrook /* Extra fields for semihosted binaries. */
122d317091dSPeter Maydell abi_ulong heap_base;
123d317091dSPeter Maydell abi_ulong heap_limit;
124a87295e8Spbrook #endif
125d317091dSPeter Maydell abi_ulong stack_base;
126851e67a1Sbellard int used; /* non zero if used */
127978efd6aSpbrook struct image_info *info;
128edf8e2afSMika Westerberg struct linux_binprm *bprm;
129624f7979Spbrook
130655ed67cSTimothy E Baldwin struct emulated_sigtable sync_signal;
131624f7979Spbrook struct emulated_sigtable sigtab[TARGET_NSIG];
132400b7f6dSPeter Maydell /*
133400b7f6dSPeter Maydell * This thread's signal mask, as requested by the guest program.
1343d3efba0SPeter Maydell * The actual signal mask of this thread may differ:
1353d3efba0SPeter Maydell * + we don't let SIGSEGV and SIGBUS be blocked while running guest code
1363d3efba0SPeter Maydell * + sometimes we block all signals to avoid races
1373d3efba0SPeter Maydell */
1383d3efba0SPeter Maydell sigset_t signal_mask;
139400b7f6dSPeter Maydell /*
140400b7f6dSPeter Maydell * The signal mask imposed by a guest sigsuspend syscall, if we are
1413d3efba0SPeter Maydell * currently in the middle of such a syscall
1423d3efba0SPeter Maydell */
1433d3efba0SPeter Maydell sigset_t sigsuspend_mask;
1443d3efba0SPeter Maydell /* Nonzero if we're leaving a sigsuspend and sigsuspend_mask is valid. */
1453d3efba0SPeter Maydell int in_sigsuspend;
1463d3efba0SPeter Maydell
147400b7f6dSPeter Maydell /*
148400b7f6dSPeter Maydell * Nonzero if process_pending_signals() needs to do something (either
1493d3efba0SPeter Maydell * handle a pending signal or unblock signals).
1503d3efba0SPeter Maydell * This flag is written from a signal handler so should be accessed via
151d73415a3SStefan Hajnoczi * the qatomic_read() and qatomic_set() functions. (It is not accessed
1523d3efba0SPeter Maydell * from multiple threads.)
1533d3efba0SPeter Maydell */
1543d3efba0SPeter Maydell int signal_pending;
1553d3efba0SPeter Maydell
1565bfce0b7SPeter Maydell /* This thread's sigaltstack, if it has one */
1575bfce0b7SPeter Maydell struct target_sigaltstack sigaltstack_used;
158eb33cdaeSCameron Esfahani
159eb33cdaeSCameron Esfahani /* Start time of task after system boot in clock ticks */
160eb33cdaeSCameron Esfahani uint64_t start_boottime;
161b1b21387SPeter Maydell } TaskState;
162851e67a1Sbellard
get_task_state(CPUState * cs)163e4e5cb4aSIlya Leoshkevich static inline TaskState *get_task_state(CPUState *cs)
164e4e5cb4aSIlya Leoshkevich {
165e4e5cb4aSIlya Leoshkevich return cs->opaque;
166e4e5cb4aSIlya Leoshkevich }
167e4e5cb4aSIlya Leoshkevich
1683b249d26SPeter Maydell abi_long do_brk(abi_ulong new_brk);
169a4dab0a0SIlya Leoshkevich int do_guest_openat(CPUArchState *cpu_env, int dirfd, const char *pathname,
17035be898eSIlya Leoshkevich int flags, mode_t mode, bool safe);
171a4dab0a0SIlya Leoshkevich ssize_t do_guest_readlink(const char *pathname, char *buf, size_t bufsiz);
172631271d7Sbellard
173edf779ffSbellard /* user access */
174edf779ffSbellard
17564d06015SThomas Weißschuh #define VERIFY_NONE 0
17668f77666SRichard Henderson #define VERIFY_READ PAGE_READ
17768f77666SRichard Henderson #define VERIFY_WRITE (PAGE_READ | PAGE_WRITE)
178edf779ffSbellard
access_ok_untagged(int type,abi_ulong addr,abi_ulong size)179c7169b02SRichard Henderson static inline bool access_ok_untagged(int type, abi_ulong addr, abi_ulong size)
180dae3270cSbellard {
181114556c5SRichard Henderson if (size == 0
18246b12f46SRichard Henderson ? !guest_addr_valid_untagged(addr)
18346b12f46SRichard Henderson : !guest_range_valid_untagged(addr, size)) {
1844feac83aSRichard Henderson return false;
1854feac83aSRichard Henderson }
186bef6f008SRichard Henderson return page_check_range((target_ulong)addr, size, type);
187dae3270cSbellard }
188edf779ffSbellard
access_ok(CPUState * cpu,int type,abi_ulong addr,abi_ulong size)189c7169b02SRichard Henderson static inline bool access_ok(CPUState *cpu, int type,
190c7169b02SRichard Henderson abi_ulong addr, abi_ulong size)
191c7169b02SRichard Henderson {
192c7169b02SRichard Henderson return access_ok_untagged(type, cpu_untagged_addr(cpu, addr), size);
193c7169b02SRichard Henderson }
194c7169b02SRichard Henderson
195658f2dc9SRichard Henderson /* NOTE __get_user and __put_user use host pointers and don't check access.
196658f2dc9SRichard Henderson These are usually used to access struct data members once the struct has
197658f2dc9SRichard Henderson been locked - usually with lock_user_struct. */
198edf779ffSbellard
199850d5e33SPeter Maydell /*
200850d5e33SPeter Maydell * Tricky points:
201850d5e33SPeter Maydell * - Use __builtin_choose_expr to avoid type promotion from ?:,
202850d5e33SPeter Maydell * - Invalid sizes result in a compile time error stemming from
203850d5e33SPeter Maydell * the fact that abort has no parameters.
204850d5e33SPeter Maydell * - It's easier to use the endian-specific unaligned load/store
205850d5e33SPeter Maydell * functions than host-endian unaligned load/store plus tswapN.
206850d5e33SPeter Maydell * - The pragmas are necessary only to silence a clang false-positive
207850d5e33SPeter Maydell * warning: see https://bugs.llvm.org/show_bug.cgi?id=39113 .
208850d5e33SPeter Maydell * - gcc has bugs in its _Pragma() support in some versions, eg
209850d5e33SPeter Maydell * https://gcc.gnu.org/bugzilla/show_bug.cgi?id=83256 -- so we only
210850d5e33SPeter Maydell * include the warning-suppression pragmas for clang
211850d5e33SPeter Maydell */
212798b8581SThomas Huth #if defined(__clang__) && __has_warning("-Waddress-of-packed-member")
213850d5e33SPeter Maydell #define PRAGMA_DISABLE_PACKED_WARNING \
214850d5e33SPeter Maydell _Pragma("GCC diagnostic push"); \
215850d5e33SPeter Maydell _Pragma("GCC diagnostic ignored \"-Waddress-of-packed-member\"")
216850d5e33SPeter Maydell
217850d5e33SPeter Maydell #define PRAGMA_REENABLE_PACKED_WARNING \
218850d5e33SPeter Maydell _Pragma("GCC diagnostic pop")
219850d5e33SPeter Maydell
220850d5e33SPeter Maydell #else
221850d5e33SPeter Maydell #define PRAGMA_DISABLE_PACKED_WARNING
222850d5e33SPeter Maydell #define PRAGMA_REENABLE_PACKED_WARNING
223850d5e33SPeter Maydell #endif
224658f2dc9SRichard Henderson
225658f2dc9SRichard Henderson #define __put_user_e(x, hptr, e) \
226850d5e33SPeter Maydell do { \
227850d5e33SPeter Maydell PRAGMA_DISABLE_PACKED_WARNING; \
228658f2dc9SRichard Henderson (__builtin_choose_expr(sizeof(*(hptr)) == 1, stb_p, \
229658f2dc9SRichard Henderson __builtin_choose_expr(sizeof(*(hptr)) == 2, stw_##e##_p, \
230658f2dc9SRichard Henderson __builtin_choose_expr(sizeof(*(hptr)) == 4, stl_##e##_p, \
231658f2dc9SRichard Henderson __builtin_choose_expr(sizeof(*(hptr)) == 8, stq_##e##_p, abort)))) \
232850d5e33SPeter Maydell ((hptr), (x)), (void)0); \
233850d5e33SPeter Maydell PRAGMA_REENABLE_PACKED_WARNING; \
234850d5e33SPeter Maydell } while (0)
235658f2dc9SRichard Henderson
236658f2dc9SRichard Henderson #define __get_user_e(x, hptr, e) \
237850d5e33SPeter Maydell do { \
238850d5e33SPeter Maydell PRAGMA_DISABLE_PACKED_WARNING; \
2390bc8ce94SPeter Maydell ((x) = (typeof(*hptr))( \
240658f2dc9SRichard Henderson __builtin_choose_expr(sizeof(*(hptr)) == 1, ldub_p, \
241658f2dc9SRichard Henderson __builtin_choose_expr(sizeof(*(hptr)) == 2, lduw_##e##_p, \
242658f2dc9SRichard Henderson __builtin_choose_expr(sizeof(*(hptr)) == 4, ldl_##e##_p, \
243658f2dc9SRichard Henderson __builtin_choose_expr(sizeof(*(hptr)) == 8, ldq_##e##_p, abort)))) \
244850d5e33SPeter Maydell (hptr)), (void)0); \
245850d5e33SPeter Maydell PRAGMA_REENABLE_PACKED_WARNING; \
246850d5e33SPeter Maydell } while (0)
247850d5e33SPeter Maydell
248658f2dc9SRichard Henderson
249ee3eb3a7SMarc-André Lureau #if TARGET_BIG_ENDIAN
250658f2dc9SRichard Henderson # define __put_user(x, hptr) __put_user_e(x, hptr, be)
251658f2dc9SRichard Henderson # define __get_user(x, hptr) __get_user_e(x, hptr, be)
252658f2dc9SRichard Henderson #else
253658f2dc9SRichard Henderson # define __put_user(x, hptr) __put_user_e(x, hptr, le)
254658f2dc9SRichard Henderson # define __get_user(x, hptr) __get_user_e(x, hptr, le)
255658f2dc9SRichard Henderson #endif
256edf779ffSbellard
257579a97f7Sbellard /* put_user()/get_user() take a guest address and check access */
258579a97f7Sbellard /* These are usually used to access an atomic data type, such as an int,
259579a97f7Sbellard * that has been passed by address. These internally perform locking
260579a97f7Sbellard * and unlocking on the data type.
261579a97f7Sbellard */
262579a97f7Sbellard #define put_user(x, gaddr, target_type) \
263edf779ffSbellard ({ \
264579a97f7Sbellard abi_ulong __gaddr = (gaddr); \
265579a97f7Sbellard target_type *__hptr; \
266a42267efSRiku Voipio abi_long __ret = 0; \
267579a97f7Sbellard if ((__hptr = lock_user(VERIFY_WRITE, __gaddr, sizeof(target_type), 0))) { \
268a42267efSRiku Voipio __put_user((x), __hptr); \
269579a97f7Sbellard unlock_user(__hptr, __gaddr, sizeof(target_type)); \
270579a97f7Sbellard } else \
271579a97f7Sbellard __ret = -TARGET_EFAULT; \
272edf779ffSbellard __ret; \
273edf779ffSbellard })
274edf779ffSbellard
275579a97f7Sbellard #define get_user(x, gaddr, target_type) \
276edf779ffSbellard ({ \
277579a97f7Sbellard abi_ulong __gaddr = (gaddr); \
278579a97f7Sbellard target_type *__hptr; \
279a42267efSRiku Voipio abi_long __ret = 0; \
280579a97f7Sbellard if ((__hptr = lock_user(VERIFY_READ, __gaddr, sizeof(target_type), 1))) { \
281a42267efSRiku Voipio __get_user((x), __hptr); \
282579a97f7Sbellard unlock_user(__hptr, __gaddr, 0); \
2832f619698Sbellard } else { \
2842f619698Sbellard /* avoid warning */ \
2852f619698Sbellard (x) = 0; \
286579a97f7Sbellard __ret = -TARGET_EFAULT; \
2872f619698Sbellard } \
288edf779ffSbellard __ret; \
289edf779ffSbellard })
290edf779ffSbellard
2912f619698Sbellard #define put_user_ual(x, gaddr) put_user((x), (gaddr), abi_ulong)
2922f619698Sbellard #define put_user_sal(x, gaddr) put_user((x), (gaddr), abi_long)
2932f619698Sbellard #define put_user_u64(x, gaddr) put_user((x), (gaddr), uint64_t)
2942f619698Sbellard #define put_user_s64(x, gaddr) put_user((x), (gaddr), int64_t)
2952f619698Sbellard #define put_user_u32(x, gaddr) put_user((x), (gaddr), uint32_t)
2962f619698Sbellard #define put_user_s32(x, gaddr) put_user((x), (gaddr), int32_t)
2972f619698Sbellard #define put_user_u16(x, gaddr) put_user((x), (gaddr), uint16_t)
2982f619698Sbellard #define put_user_s16(x, gaddr) put_user((x), (gaddr), int16_t)
2992f619698Sbellard #define put_user_u8(x, gaddr) put_user((x), (gaddr), uint8_t)
3002f619698Sbellard #define put_user_s8(x, gaddr) put_user((x), (gaddr), int8_t)
3012f619698Sbellard
3022f619698Sbellard #define get_user_ual(x, gaddr) get_user((x), (gaddr), abi_ulong)
3032f619698Sbellard #define get_user_sal(x, gaddr) get_user((x), (gaddr), abi_long)
3042f619698Sbellard #define get_user_u64(x, gaddr) get_user((x), (gaddr), uint64_t)
3052f619698Sbellard #define get_user_s64(x, gaddr) get_user((x), (gaddr), int64_t)
3062f619698Sbellard #define get_user_u32(x, gaddr) get_user((x), (gaddr), uint32_t)
3072f619698Sbellard #define get_user_s32(x, gaddr) get_user((x), (gaddr), int32_t)
3082f619698Sbellard #define get_user_u16(x, gaddr) get_user((x), (gaddr), uint16_t)
3092f619698Sbellard #define get_user_s16(x, gaddr) get_user((x), (gaddr), int16_t)
3102f619698Sbellard #define get_user_u8(x, gaddr) get_user((x), (gaddr), uint8_t)
3112f619698Sbellard #define get_user_s8(x, gaddr) get_user((x), (gaddr), int8_t)
3122f619698Sbellard
313579a97f7Sbellard /* copy_from_user() and copy_to_user() are usually used to copy data
314579a97f7Sbellard * buffers between the target and host. These internally perform
315579a97f7Sbellard * locking/unlocking of the memory.
316579a97f7Sbellard */
317360f0abdSRichard Henderson int copy_from_user(void *hptr, abi_ulong gaddr, ssize_t len);
318360f0abdSRichard Henderson int copy_to_user(abi_ulong gaddr, void *hptr, ssize_t len);
319579a97f7Sbellard
32053a5960aSpbrook /* Functions for accessing guest memory. The tget and tput functions
3216f20f55bSStefan Weil read/write single values, byteswapping as necessary. The lock_user function
32253a5960aSpbrook gets a pointer to a contiguous area of guest memory, but does not perform
3236f20f55bSStefan Weil any byteswapping. lock_user may return either a pointer to the guest
32453a5960aSpbrook memory, or a temporary buffer. */
32553a5960aSpbrook
32653a5960aSpbrook /* Lock an area of guest memory into the host. If copy is true then the
32753a5960aSpbrook host area will have the same contents as the guest. */
328360f0abdSRichard Henderson void *lock_user(int type, abi_ulong guest_addr, ssize_t len, bool copy);
329edf779ffSbellard
330579a97f7Sbellard /* Unlock an area of guest memory. The first LEN bytes must be
3311235fc06Sths flushed back to guest memory. host_ptr = NULL is explicitly
332579a97f7Sbellard allowed and does nothing. */
3331f2355f5SIlya Leoshkevich #ifndef CONFIG_DEBUG_REMAP
unlock_user(void * host_ptr,abi_ulong guest_addr,ssize_t len)334360f0abdSRichard Henderson static inline void unlock_user(void *host_ptr, abi_ulong guest_addr,
335360f0abdSRichard Henderson ssize_t len)
336360f0abdSRichard Henderson {
337360f0abdSRichard Henderson /* no-op */
338360f0abdSRichard Henderson }
339687ca797SRichard Henderson #else
340360f0abdSRichard Henderson void unlock_user(void *host_ptr, abi_ulong guest_addr, ssize_t len);
34153a5960aSpbrook #endif
342edf779ffSbellard
343579a97f7Sbellard /* Return the length of a string in target memory or -TARGET_EFAULT if
344579a97f7Sbellard access error. */
34509f679b6SRichard Henderson ssize_t target_strlen(abi_ulong gaddr);
346edf779ffSbellard
34753a5960aSpbrook /* Like lock_user but for null terminated strings. */
348687ca797SRichard Henderson void *lock_user_string(abi_ulong guest_addr);
34953a5960aSpbrook
35041d1af4dSStefan Weil /* Helper macros for locking/unlocking a target struct. */
351579a97f7Sbellard #define lock_user_struct(type, host_ptr, guest_addr, copy) \
352579a97f7Sbellard (host_ptr = lock_user(type, guest_addr, sizeof(*host_ptr), copy))
35353a5960aSpbrook #define unlock_user_struct(host_ptr, guest_addr, copy) \
35453a5960aSpbrook unlock_user(host_ptr, guest_addr, (copy) ? sizeof(*host_ptr) : 0)
35553a5960aSpbrook
356e88de099Sbellard #endif /* QEMU_H */
357