Reorganize option rom (+linux kernel) loading.
[qemu.git] / bsd-user / qemu.h
blob9f4cd1ba01498f2d99156816bff8516a8b10031d
1 #ifndef QEMU_H
2 #define QEMU_H
4 #include <signal.h>
5 #include <string.h>
7 #include "cpu.h"
9 #undef DEBUG_REMAP
10 #ifdef DEBUG_REMAP
11 #include <stdlib.h>
12 #endif /* DEBUG_REMAP */
14 #include "qemu-types.h"
16 enum BSDType {
17 target_freebsd,
18 target_netbsd,
19 target_openbsd,
22 #include "syscall_defs.h"
23 #include "syscall.h"
24 #include "target_signal.h"
25 #include "gdbstub.h"
27 #if defined(CONFIG_USE_NPTL)
28 #define THREAD __thread
29 #else
30 #define THREAD
31 #endif
33 /* This struct is used to hold certain information about the image.
34 * Basically, it replicates in user space what would be certain
35 * task_struct fields in the kernel
37 struct image_info {
38 abi_ulong load_addr;
39 abi_ulong start_code;
40 abi_ulong end_code;
41 abi_ulong start_data;
42 abi_ulong end_data;
43 abi_ulong start_brk;
44 abi_ulong brk;
45 abi_ulong start_mmap;
46 abi_ulong mmap;
47 abi_ulong rss;
48 abi_ulong start_stack;
49 abi_ulong entry;
50 abi_ulong code_offset;
51 abi_ulong data_offset;
52 char **host_argv;
53 int personality;
56 #define MAX_SIGQUEUE_SIZE 1024
58 struct sigqueue {
59 struct sigqueue *next;
60 //target_siginfo_t info;
63 struct emulated_sigtable {
64 int pending; /* true if signal is pending */
65 struct sigqueue *first;
66 struct sigqueue info; /* in order to always have memory for the
67 first signal, we put it here */
70 /* NOTE: we force a big alignment so that the stack stored after is
71 aligned too */
72 typedef struct TaskState {
73 struct TaskState *next;
74 int used; /* non zero if used */
75 struct image_info *info;
77 struct emulated_sigtable sigtab[TARGET_NSIG];
78 struct sigqueue sigqueue_table[MAX_SIGQUEUE_SIZE]; /* siginfo queue */
79 struct sigqueue *first_free; /* first free siginfo queue entry */
80 int signal_pending; /* non zero if a signal may be pending */
82 uint8_t stack[0];
83 } __attribute__((aligned(16))) TaskState;
85 void init_task_state(TaskState *ts);
86 extern const char *qemu_uname_release;
87 #if defined(CONFIG_USE_GUEST_BASE)
88 extern unsigned long mmap_min_addr;
89 #endif
91 /* ??? See if we can avoid exposing so much of the loader internals. */
93 * MAX_ARG_PAGES defines the number of pages allocated for arguments
94 * and envelope for the new program. 32 should suffice, this gives
95 * a maximum env+arg of 128kB w/4KB pages!
97 #define MAX_ARG_PAGES 32
100 * This structure is used to hold the arguments that are
101 * used when loading binaries.
103 struct linux_binprm {
104 char buf[128];
105 void *page[MAX_ARG_PAGES];
106 abi_ulong p;
107 int fd;
108 int e_uid, e_gid;
109 int argc, envc;
110 char **argv;
111 char **envp;
112 char * filename; /* Name of binary */
115 void do_init_thread(struct target_pt_regs *regs, struct image_info *infop);
116 abi_ulong loader_build_argptr(int envc, int argc, abi_ulong sp,
117 abi_ulong stringp, int push_ptr);
118 int loader_exec(const char * filename, char ** argv, char ** envp,
119 struct target_pt_regs * regs, struct image_info *infop);
121 int load_elf_binary(struct linux_binprm * bprm, struct target_pt_regs * regs,
122 struct image_info * info);
123 int load_flt_binary(struct linux_binprm * bprm, struct target_pt_regs * regs,
124 struct image_info * info);
126 abi_long memcpy_to_target(abi_ulong dest, const void *src,
127 unsigned long len);
128 void target_set_brk(abi_ulong new_brk);
129 abi_long do_brk(abi_ulong new_brk);
130 void syscall_init(void);
131 abi_long do_freebsd_syscall(void *cpu_env, int num, abi_long arg1,
132 abi_long arg2, abi_long arg3, abi_long arg4,
133 abi_long arg5, abi_long arg6);
134 abi_long do_netbsd_syscall(void *cpu_env, int num, abi_long arg1,
135 abi_long arg2, abi_long arg3, abi_long arg4,
136 abi_long arg5, abi_long arg6);
137 abi_long do_openbsd_syscall(void *cpu_env, int num, abi_long arg1,
138 abi_long arg2, abi_long arg3, abi_long arg4,
139 abi_long arg5, abi_long arg6);
140 void gemu_log(const char *fmt, ...) __attribute__((format(printf,1,2)));
141 extern THREAD CPUState *thread_env;
142 void cpu_loop(CPUState *env, enum BSDType bsd_type);
143 char *target_strerror(int err);
144 int get_osversion(void);
145 void fork_start(void);
146 void fork_end(int child);
148 #include "qemu-log.h"
150 /* strace.c */
151 void
152 print_freebsd_syscall(int num,
153 abi_long arg1, abi_long arg2, abi_long arg3,
154 abi_long arg4, abi_long arg5, abi_long arg6);
155 void print_freebsd_syscall_ret(int num, abi_long ret);
156 void
157 print_netbsd_syscall(int num,
158 abi_long arg1, abi_long arg2, abi_long arg3,
159 abi_long arg4, abi_long arg5, abi_long arg6);
160 void print_netbsd_syscall_ret(int num, abi_long ret);
161 void
162 print_openbsd_syscall(int num,
163 abi_long arg1, abi_long arg2, abi_long arg3,
164 abi_long arg4, abi_long arg5, abi_long arg6);
165 void print_openbsd_syscall_ret(int num, abi_long ret);
166 extern int do_strace;
168 /* signal.c */
169 void process_pending_signals(CPUState *cpu_env);
170 void signal_init(void);
171 //int queue_signal(CPUState *env, int sig, target_siginfo_t *info);
172 //void host_to_target_siginfo(target_siginfo_t *tinfo, const siginfo_t *info);
173 //void target_to_host_siginfo(siginfo_t *info, const target_siginfo_t *tinfo);
174 long do_sigreturn(CPUState *env);
175 long do_rt_sigreturn(CPUState *env);
176 abi_long do_sigaltstack(abi_ulong uss_addr, abi_ulong uoss_addr, abi_ulong sp);
178 /* mmap.c */
179 int target_mprotect(abi_ulong start, abi_ulong len, int prot);
180 abi_long target_mmap(abi_ulong start, abi_ulong len, int prot,
181 int flags, int fd, abi_ulong offset);
182 int target_munmap(abi_ulong start, abi_ulong len);
183 abi_long target_mremap(abi_ulong old_addr, abi_ulong old_size,
184 abi_ulong new_size, unsigned long flags,
185 abi_ulong new_addr);
186 int target_msync(abi_ulong start, abi_ulong len, int flags);
187 extern unsigned long last_brk;
188 void mmap_lock(void);
189 void mmap_unlock(void);
190 void cpu_list_lock(void);
191 void cpu_list_unlock(void);
192 #if defined(CONFIG_USE_NPTL)
193 void mmap_fork_start(void);
194 void mmap_fork_end(int child);
195 #endif
197 /* main.c */
198 extern unsigned long x86_stack_size;
200 /* user access */
202 #define VERIFY_READ 0
203 #define VERIFY_WRITE 1 /* implies read access */
205 static inline int access_ok(int type, abi_ulong addr, abi_ulong size)
207 return page_check_range((target_ulong)addr, size,
208 (type == VERIFY_READ) ? PAGE_READ : (PAGE_READ | PAGE_WRITE)) == 0;
211 /* NOTE __get_user and __put_user use host pointers and don't check access. */
212 /* These are usually used to access struct data members once the
213 * struct has been locked - usually with lock_user_struct().
215 #define __put_user(x, hptr)\
217 int size = sizeof(*hptr);\
218 switch(size) {\
219 case 1:\
220 *(uint8_t *)(hptr) = (uint8_t)(typeof(*hptr))(x);\
221 break;\
222 case 2:\
223 *(uint16_t *)(hptr) = tswap16((typeof(*hptr))(x));\
224 break;\
225 case 4:\
226 *(uint32_t *)(hptr) = tswap32((typeof(*hptr))(x));\
227 break;\
228 case 8:\
229 *(uint64_t *)(hptr) = tswap64((typeof(*hptr))(x));\
230 break;\
231 default:\
232 abort();\
237 #define __get_user(x, hptr) \
239 int size = sizeof(*hptr);\
240 switch(size) {\
241 case 1:\
242 x = (typeof(*hptr))*(uint8_t *)(hptr);\
243 break;\
244 case 2:\
245 x = (typeof(*hptr))tswap16(*(uint16_t *)(hptr));\
246 break;\
247 case 4:\
248 x = (typeof(*hptr))tswap32(*(uint32_t *)(hptr));\
249 break;\
250 case 8:\
251 x = (typeof(*hptr))tswap64(*(uint64_t *)(hptr));\
252 break;\
253 default:\
254 /* avoid warning */\
255 x = 0;\
256 abort();\
261 /* put_user()/get_user() take a guest address and check access */
262 /* These are usually used to access an atomic data type, such as an int,
263 * that has been passed by address. These internally perform locking
264 * and unlocking on the data type.
266 #define put_user(x, gaddr, target_type) \
267 ({ \
268 abi_ulong __gaddr = (gaddr); \
269 target_type *__hptr; \
270 abi_long __ret; \
271 if ((__hptr = lock_user(VERIFY_WRITE, __gaddr, sizeof(target_type), 0))) { \
272 __ret = __put_user((x), __hptr); \
273 unlock_user(__hptr, __gaddr, sizeof(target_type)); \
274 } else \
275 __ret = -TARGET_EFAULT; \
276 __ret; \
279 #define get_user(x, gaddr, target_type) \
280 ({ \
281 abi_ulong __gaddr = (gaddr); \
282 target_type *__hptr; \
283 abi_long __ret; \
284 if ((__hptr = lock_user(VERIFY_READ, __gaddr, sizeof(target_type), 1))) { \
285 __ret = __get_user((x), __hptr); \
286 unlock_user(__hptr, __gaddr, 0); \
287 } else { \
288 /* avoid warning */ \
289 (x) = 0; \
290 __ret = -TARGET_EFAULT; \
292 __ret; \
295 #define put_user_ual(x, gaddr) put_user((x), (gaddr), abi_ulong)
296 #define put_user_sal(x, gaddr) put_user((x), (gaddr), abi_long)
297 #define put_user_u64(x, gaddr) put_user((x), (gaddr), uint64_t)
298 #define put_user_s64(x, gaddr) put_user((x), (gaddr), int64_t)
299 #define put_user_u32(x, gaddr) put_user((x), (gaddr), uint32_t)
300 #define put_user_s32(x, gaddr) put_user((x), (gaddr), int32_t)
301 #define put_user_u16(x, gaddr) put_user((x), (gaddr), uint16_t)
302 #define put_user_s16(x, gaddr) put_user((x), (gaddr), int16_t)
303 #define put_user_u8(x, gaddr) put_user((x), (gaddr), uint8_t)
304 #define put_user_s8(x, gaddr) put_user((x), (gaddr), int8_t)
306 #define get_user_ual(x, gaddr) get_user((x), (gaddr), abi_ulong)
307 #define get_user_sal(x, gaddr) get_user((x), (gaddr), abi_long)
308 #define get_user_u64(x, gaddr) get_user((x), (gaddr), uint64_t)
309 #define get_user_s64(x, gaddr) get_user((x), (gaddr), int64_t)
310 #define get_user_u32(x, gaddr) get_user((x), (gaddr), uint32_t)
311 #define get_user_s32(x, gaddr) get_user((x), (gaddr), int32_t)
312 #define get_user_u16(x, gaddr) get_user((x), (gaddr), uint16_t)
313 #define get_user_s16(x, gaddr) get_user((x), (gaddr), int16_t)
314 #define get_user_u8(x, gaddr) get_user((x), (gaddr), uint8_t)
315 #define get_user_s8(x, gaddr) get_user((x), (gaddr), int8_t)
317 /* copy_from_user() and copy_to_user() are usually used to copy data
318 * buffers between the target and host. These internally perform
319 * locking/unlocking of the memory.
321 abi_long copy_from_user(void *hptr, abi_ulong gaddr, size_t len);
322 abi_long copy_to_user(abi_ulong gaddr, void *hptr, size_t len);
324 /* Functions for accessing guest memory. The tget and tput functions
325 read/write single values, byteswapping as neccessary. The lock_user
326 gets a pointer to a contiguous area of guest memory, but does not perform
327 and byteswapping. lock_user may return either a pointer to the guest
328 memory, or a temporary buffer. */
330 /* Lock an area of guest memory into the host. If copy is true then the
331 host area will have the same contents as the guest. */
332 static inline void *lock_user(int type, abi_ulong guest_addr, long len, int copy)
334 if (!access_ok(type, guest_addr, len))
335 return NULL;
336 #ifdef DEBUG_REMAP
338 void *addr;
339 addr = malloc(len);
340 if (copy)
341 memcpy(addr, g2h(guest_addr), len);
342 else
343 memset(addr, 0, len);
344 return addr;
346 #else
347 return g2h(guest_addr);
348 #endif
351 /* Unlock an area of guest memory. The first LEN bytes must be
352 flushed back to guest memory. host_ptr = NULL is explicitly
353 allowed and does nothing. */
354 static inline void unlock_user(void *host_ptr, abi_ulong guest_addr,
355 long len)
358 #ifdef DEBUG_REMAP
359 if (!host_ptr)
360 return;
361 if (host_ptr == g2h(guest_addr))
362 return;
363 if (len > 0)
364 memcpy(g2h(guest_addr), host_ptr, len);
365 free(host_ptr);
366 #endif
369 /* Return the length of a string in target memory or -TARGET_EFAULT if
370 access error. */
371 abi_long target_strlen(abi_ulong gaddr);
373 /* Like lock_user but for null terminated strings. */
374 static inline void *lock_user_string(abi_ulong guest_addr)
376 abi_long len;
377 len = target_strlen(guest_addr);
378 if (len < 0)
379 return NULL;
380 return lock_user(VERIFY_READ, guest_addr, (long)(len + 1), 1);
383 /* Helper macros for locking/ulocking a target struct. */
384 #define lock_user_struct(type, host_ptr, guest_addr, copy) \
385 (host_ptr = lock_user(type, guest_addr, sizeof(*host_ptr), copy))
386 #define unlock_user_struct(host_ptr, guest_addr, copy) \
387 unlock_user(host_ptr, guest_addr, (copy) ? sizeof(*host_ptr) : 0)
389 #if defined(CONFIG_USE_NPTL)
390 #include <pthread.h>
391 #endif
393 #endif /* QEMU_H */