xref: /openbmc/qemu/bsd-user/qemu.h (revision 98b34d354b5da78880cb39dc3a7db91c790f7c7d)
1 /*
2  *  qemu bsd user mode definition
3  *
4  *  This program is free software; you can redistribute it and/or modify
5  *  it under the terms of the GNU General Public License as published by
6  *  the Free Software Foundation; either version 2 of the License, or
7  *  (at your option) any later version.
8  *
9  *  This program is distributed in the hope that it will be useful,
10  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
11  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12  *  GNU General Public License for more details.
13  *
14  *  You should have received a copy of the GNU General Public License
15  *  along with this program; if not, see <http://www.gnu.org/licenses/>.
16  */
17 #ifndef QEMU_H
18 #define QEMU_H
19 
20 
21 #include "qemu/osdep.h"
22 #include "cpu.h"
23 #include "qemu/units.h"
24 #include "exec/cpu_ldst.h"
25 #include "exec/exec-all.h"
26 
27 #undef DEBUG_REMAP
28 
29 #include "exec/user/abitypes.h"
30 
31 extern char **environ;
32 
33 enum BSDType {
34     target_freebsd,
35     target_netbsd,
36     target_openbsd,
37 };
38 extern enum BSDType bsd_type;
39 
40 #include "exec/user/thunk.h"
41 #include "target_arch.h"
42 #include "syscall_defs.h"
43 #include "target_syscall.h"
44 #include "target_os_vmparam.h"
45 #include "target_os_signal.h"
46 #include "exec/gdbstub.h"
47 
48 /*
49  * This struct is used to hold certain information about the image.  Basically,
50  * it replicates in user space what would be certain task_struct fields in the
51  * kernel
52  */
53 struct image_info {
54     abi_ulong load_addr;
55     abi_ulong start_code;
56     abi_ulong end_code;
57     abi_ulong start_data;
58     abi_ulong end_data;
59     abi_ulong start_brk;
60     abi_ulong brk;
61     abi_ulong start_mmap;
62     abi_ulong mmap;
63     abi_ulong rss;
64     abi_ulong start_stack;
65     abi_ulong entry;
66     abi_ulong code_offset;
67     abi_ulong data_offset;
68 };
69 
70 #define MAX_SIGQUEUE_SIZE 1024
71 
72 struct sigqueue {
73     struct sigqueue *next;
74 };
75 
76 struct emulated_sigtable {
77     int pending; /* true if signal is pending */
78     struct sigqueue *first;
79     /* in order to always have memory for the first signal, we put it here */
80     struct sigqueue info;
81 };
82 
83 /*
84  * NOTE: we force a big alignment so that the stack stored after is aligned too
85  */
86 typedef struct TaskState {
87     pid_t ts_tid;     /* tid (or pid) of this task */
88 
89     struct TaskState *next;
90     struct bsd_binprm *bprm;
91     int used; /* non zero if used */
92     struct image_info *info;
93 
94     struct emulated_sigtable sigtab[TARGET_NSIG];
95     struct sigqueue sigqueue_table[MAX_SIGQUEUE_SIZE]; /* siginfo queue */
96     struct sigqueue *first_free; /* first free siginfo queue entry */
97     int signal_pending; /* non zero if a signal may be pending */
98 
99     uint8_t stack[];
100 } __attribute__((aligned(16))) TaskState;
101 
102 void init_task_state(TaskState *ts);
103 extern const char *qemu_uname_release;
104 extern unsigned long mmap_min_addr;
105 
106 /*
107  * TARGET_ARG_MAX defines the number of bytes allocated for arguments
108  * and envelope for the new program. 256k should suffice for a reasonable
109  * maxiumum env+arg in 32-bit environments, bump it up to 512k for !ILP32
110  * platforms.
111  */
112 #if TARGET_ABI_BITS > 32
113 #define TARGET_ARG_MAX (512 * KiB)
114 #else
115 #define TARGET_ARG_MAX (256 * KiB)
116 #endif
117 #define MAX_ARG_PAGES (TARGET_ARG_MAX / TARGET_PAGE_SIZE)
118 
119 /*
120  * This structure is used to hold the arguments that are
121  * used when loading binaries.
122  */
123 struct bsd_binprm {
124         char buf[128];
125         void *page[MAX_ARG_PAGES];
126         abi_ulong p;
127         abi_ulong stringp;
128         int fd;
129         int e_uid, e_gid;
130         int argc, envc;
131         char **argv;
132         char **envp;
133         char *filename;         /* (Given) Name of binary */
134         char *fullpath;         /* Full path of binary */
135 };
136 
137 void do_init_thread(struct target_pt_regs *regs, struct image_info *infop);
138 abi_ulong loader_build_argptr(int envc, int argc, abi_ulong sp,
139                               abi_ulong stringp);
140 int loader_exec(const char *filename, char **argv, char **envp,
141                 struct target_pt_regs *regs, struct image_info *infop,
142                 struct bsd_binprm *bprm);
143 
144 int load_elf_binary(struct bsd_binprm *bprm, struct target_pt_regs *regs,
145                     struct image_info *info);
146 int load_flt_binary(struct bsd_binprm *bprm, struct target_pt_regs *regs,
147                     struct image_info *info);
148 
149 abi_long memcpy_to_target(abi_ulong dest, const void *src,
150                           unsigned long len);
151 void target_set_brk(abi_ulong new_brk);
152 abi_long do_brk(abi_ulong new_brk);
153 void syscall_init(void);
154 abi_long do_freebsd_syscall(void *cpu_env, int num, abi_long arg1,
155                             abi_long arg2, abi_long arg3, abi_long arg4,
156                             abi_long arg5, abi_long arg6, abi_long arg7,
157                             abi_long arg8);
158 abi_long do_netbsd_syscall(void *cpu_env, int num, abi_long arg1,
159                            abi_long arg2, abi_long arg3, abi_long arg4,
160                            abi_long arg5, abi_long arg6);
161 abi_long do_openbsd_syscall(void *cpu_env, int num, abi_long arg1,
162                             abi_long arg2, abi_long arg3, abi_long arg4,
163                             abi_long arg5, abi_long arg6);
164 void gemu_log(const char *fmt, ...) GCC_FMT_ATTR(1, 2);
165 extern __thread CPUState *thread_cpu;
166 void cpu_loop(CPUArchState *env);
167 char *target_strerror(int err);
168 int get_osversion(void);
169 void fork_start(void);
170 void fork_end(int child);
171 
172 #include "qemu/log.h"
173 
174 /* strace.c */
175 struct syscallname {
176     int nr;
177     const char *name;
178     const char *format;
179     void (*call)(const struct syscallname *,
180                  abi_long, abi_long, abi_long,
181                  abi_long, abi_long, abi_long);
182     void (*result)(const struct syscallname *, abi_long);
183 };
184 
185 void
186 print_freebsd_syscall(int num,
187                       abi_long arg1, abi_long arg2, abi_long arg3,
188                       abi_long arg4, abi_long arg5, abi_long arg6);
189 void print_freebsd_syscall_ret(int num, abi_long ret);
190 void
191 print_netbsd_syscall(int num,
192                      abi_long arg1, abi_long arg2, abi_long arg3,
193                      abi_long arg4, abi_long arg5, abi_long arg6);
194 void print_netbsd_syscall_ret(int num, abi_long ret);
195 void
196 print_openbsd_syscall(int num,
197                       abi_long arg1, abi_long arg2, abi_long arg3,
198                       abi_long arg4, abi_long arg5, abi_long arg6);
199 void print_openbsd_syscall_ret(int num, abi_long ret);
200 extern int do_strace;
201 
202 /* signal.c */
203 void process_pending_signals(CPUArchState *cpu_env);
204 void signal_init(void);
205 long do_sigreturn(CPUArchState *env);
206 long do_rt_sigreturn(CPUArchState *env);
207 abi_long do_sigaltstack(abi_ulong uss_addr, abi_ulong uoss_addr, abi_ulong sp);
208 
209 /* mmap.c */
210 int target_mprotect(abi_ulong start, abi_ulong len, int prot);
211 abi_long target_mmap(abi_ulong start, abi_ulong len, int prot,
212                      int flags, int fd, abi_ulong offset);
213 int target_munmap(abi_ulong start, abi_ulong len);
214 abi_long target_mremap(abi_ulong old_addr, abi_ulong old_size,
215                        abi_ulong new_size, unsigned long flags,
216                        abi_ulong new_addr);
217 int target_msync(abi_ulong start, abi_ulong len, int flags);
218 extern unsigned long last_brk;
219 void mmap_fork_start(void);
220 void mmap_fork_end(int child);
221 
222 /* main.c */
223 extern char qemu_proc_pathname[];
224 extern unsigned long target_maxtsiz;
225 extern unsigned long target_dfldsiz;
226 extern unsigned long target_maxdsiz;
227 extern unsigned long target_dflssiz;
228 extern unsigned long target_maxssiz;
229 extern unsigned long target_sgrowsiz;
230 
231 /* user access */
232 
233 #define VERIFY_READ  PAGE_READ
234 #define VERIFY_WRITE (PAGE_READ | PAGE_WRITE)
235 
236 static inline bool access_ok(int type, abi_ulong addr, abi_ulong size)
237 {
238     return page_check_range((target_ulong)addr, size, type) == 0;
239 }
240 
241 /*
242  * NOTE __get_user and __put_user use host pointers and don't check access.
243  *
244  * These are usually used to access struct data members once the struct has been
245  * locked - usually with lock_user_struct().
246  */
247 #define __put_user(x, hptr)\
248 ({\
249     int size = sizeof(*hptr);\
250     switch (size) {\
251     case 1:\
252         *(uint8_t *)(hptr) = (uint8_t)(typeof(*hptr))(x);\
253         break;\
254     case 2:\
255         *(uint16_t *)(hptr) = tswap16((typeof(*hptr))(x));\
256         break;\
257     case 4:\
258         *(uint32_t *)(hptr) = tswap32((typeof(*hptr))(x));\
259         break;\
260     case 8:\
261         *(uint64_t *)(hptr) = tswap64((typeof(*hptr))(x));\
262         break;\
263     default:\
264         abort();\
265     } \
266     0;\
267 })
268 
269 #define __get_user(x, hptr) \
270 ({\
271     int size = sizeof(*hptr);\
272     switch (size) {\
273     case 1:\
274         x = (typeof(*hptr))*(uint8_t *)(hptr);\
275         break;\
276     case 2:\
277         x = (typeof(*hptr))tswap16(*(uint16_t *)(hptr));\
278         break;\
279     case 4:\
280         x = (typeof(*hptr))tswap32(*(uint32_t *)(hptr));\
281         break;\
282     case 8:\
283         x = (typeof(*hptr))tswap64(*(uint64_t *)(hptr));\
284         break;\
285     default:\
286         x = 0;\
287         abort();\
288     } \
289     0;\
290 })
291 
292 /*
293  * put_user()/get_user() take a guest address and check access
294  *
295  * These are usually used to access an atomic data type, such as an int, that
296  * has been passed by address.  These internally perform locking and unlocking
297  * on the data type.
298  */
299 #define put_user(x, gaddr, target_type)                                 \
300 ({                                                                      \
301     abi_ulong __gaddr = (gaddr);                                        \
302     target_type *__hptr;                                                \
303     abi_long __ret;                                                     \
304     __hptr = lock_user(VERIFY_WRITE, __gaddr, sizeof(target_type), 0);  \
305     if (__hptr) {                                                       \
306         __ret = __put_user((x), __hptr);                                \
307         unlock_user(__hptr, __gaddr, sizeof(target_type));              \
308     } else                                                              \
309         __ret = -TARGET_EFAULT;                                         \
310     __ret;                                                              \
311 })
312 
313 #define get_user(x, gaddr, target_type)                                 \
314 ({                                                                      \
315     abi_ulong __gaddr = (gaddr);                                        \
316     target_type *__hptr;                                                \
317     abi_long __ret;                                                     \
318     __hptr = lock_user(VERIFY_READ, __gaddr, sizeof(target_type), 1);   \
319     if (__hptr) {                                                       \
320         __ret = __get_user((x), __hptr);                                \
321         unlock_user(__hptr, __gaddr, 0);                                \
322     } else {                                                            \
323         (x) = 0;                                                        \
324         __ret = -TARGET_EFAULT;                                         \
325     }                                                                   \
326     __ret;                                                              \
327 })
328 
329 #define put_user_ual(x, gaddr) put_user((x), (gaddr), abi_ulong)
330 #define put_user_sal(x, gaddr) put_user((x), (gaddr), abi_long)
331 #define put_user_u64(x, gaddr) put_user((x), (gaddr), uint64_t)
332 #define put_user_s64(x, gaddr) put_user((x), (gaddr), int64_t)
333 #define put_user_u32(x, gaddr) put_user((x), (gaddr), uint32_t)
334 #define put_user_s32(x, gaddr) put_user((x), (gaddr), int32_t)
335 #define put_user_u16(x, gaddr) put_user((x), (gaddr), uint16_t)
336 #define put_user_s16(x, gaddr) put_user((x), (gaddr), int16_t)
337 #define put_user_u8(x, gaddr)  put_user((x), (gaddr), uint8_t)
338 #define put_user_s8(x, gaddr)  put_user((x), (gaddr), int8_t)
339 
340 #define get_user_ual(x, gaddr) get_user((x), (gaddr), abi_ulong)
341 #define get_user_sal(x, gaddr) get_user((x), (gaddr), abi_long)
342 #define get_user_u64(x, gaddr) get_user((x), (gaddr), uint64_t)
343 #define get_user_s64(x, gaddr) get_user((x), (gaddr), int64_t)
344 #define get_user_u32(x, gaddr) get_user((x), (gaddr), uint32_t)
345 #define get_user_s32(x, gaddr) get_user((x), (gaddr), int32_t)
346 #define get_user_u16(x, gaddr) get_user((x), (gaddr), uint16_t)
347 #define get_user_s16(x, gaddr) get_user((x), (gaddr), int16_t)
348 #define get_user_u8(x, gaddr)  get_user((x), (gaddr), uint8_t)
349 #define get_user_s8(x, gaddr)  get_user((x), (gaddr), int8_t)
350 
351 /*
352  * copy_from_user() and copy_to_user() are usually used to copy data
353  * buffers between the target and host.  These internally perform
354  * locking/unlocking of the memory.
355  */
356 abi_long copy_from_user(void *hptr, abi_ulong gaddr, size_t len);
357 abi_long copy_to_user(abi_ulong gaddr, void *hptr, size_t len);
358 
359 /*
360  * Functions for accessing guest memory.  The tget and tput functions
361  * read/write single values, byteswapping as necessary.  The lock_user function
362  * gets a pointer to a contiguous area of guest memory, but does not perform
363  * any byteswapping.  lock_user may return either a pointer to the guest
364  * memory, or a temporary buffer.
365  */
366 
367 /*
368  * Lock an area of guest memory into the host.  If copy is true then the
369  * host area will have the same contents as the guest.
370  */
371 static inline void *lock_user(int type, abi_ulong guest_addr, long len,
372                               int copy)
373 {
374     if (!access_ok(type, guest_addr, len)) {
375         return NULL;
376     }
377 #ifdef DEBUG_REMAP
378     {
379         void *addr;
380         addr = g_malloc(len);
381         if (copy) {
382             memcpy(addr, g2h_untagged(guest_addr), len);
383         } else {
384             memset(addr, 0, len);
385         }
386         return addr;
387     }
388 #else
389     return g2h_untagged(guest_addr);
390 #endif
391 }
392 
393 /*
394  * Unlock an area of guest memory.  The first LEN bytes must be flushed back to
395  * guest memory. host_ptr = NULL is explicitly allowed and does nothing.
396  */
397 static inline void unlock_user(void *host_ptr, abi_ulong guest_addr,
398                                long len)
399 {
400 
401 #ifdef DEBUG_REMAP
402     if (!host_ptr) {
403         return;
404     }
405     if (host_ptr == g2h_untagged(guest_addr)) {
406         return;
407     }
408     if (len > 0) {
409         memcpy(g2h_untagged(guest_addr), host_ptr, len);
410     }
411     g_free(host_ptr);
412 #endif
413 }
414 
415 /*
416  * Return the length of a string in target memory or -TARGET_EFAULT if access
417  * error.
418  */
419 abi_long target_strlen(abi_ulong gaddr);
420 
421 /* Like lock_user but for null terminated strings.  */
422 static inline void *lock_user_string(abi_ulong guest_addr)
423 {
424     abi_long len;
425     len = target_strlen(guest_addr);
426     if (len < 0) {
427         return NULL;
428     }
429     return lock_user(VERIFY_READ, guest_addr, (long)(len + 1), 1);
430 }
431 
432 /* Helper macros for locking/unlocking a target struct.  */
433 #define lock_user_struct(type, host_ptr, guest_addr, copy)      \
434     (host_ptr = lock_user(type, guest_addr, sizeof(*host_ptr), copy))
435 #define unlock_user_struct(host_ptr, guest_addr, copy)          \
436     unlock_user(host_ptr, guest_addr, (copy) ? sizeof(*host_ptr) : 0)
437 
438 #include <pthread.h>
439 
440 #endif /* QEMU_H */
441