New ppc64-linux-user target.
[qemu] / linux-user / qemu.h
1 #ifndef QEMU_H
2 #define QEMU_H
3
4 #include "thunk.h"
5
6 #include <signal.h>
7 #include <string.h>
8 #include "syscall_defs.h"
9
10 #include "cpu.h"
11 #include "syscall.h"
12 #include "gdbstub.h"
13
14 /* This struct is used to hold certain information about the image.
15  * Basically, it replicates in user space what would be certain
16  * task_struct fields in the kernel
17  */
18 struct image_info {
19         target_ulong    load_addr;
20         unsigned long   start_code;
21         unsigned long   end_code;
22         unsigned long   start_data;
23         unsigned long   end_data;
24         unsigned long   start_brk;
25         unsigned long   brk;
26         unsigned long   start_mmap;
27         unsigned long   mmap;
28         unsigned long   rss;
29         unsigned long   start_stack;
30         unsigned long   entry;
31         target_ulong    code_offset;
32         target_ulong    data_offset;
33         char            **host_argv;
34         int             personality;
35 };
36
37 #ifdef TARGET_I386
38 /* Information about the current linux thread */
39 struct vm86_saved_state {
40     uint32_t eax; /* return code */
41     uint32_t ebx;
42     uint32_t ecx;
43     uint32_t edx;
44     uint32_t esi;
45     uint32_t edi;
46     uint32_t ebp;
47     uint32_t esp;
48     uint32_t eflags;
49     uint32_t eip;
50     uint16_t cs, ss, ds, es, fs, gs;
51 };
52 #endif
53
54 #ifdef TARGET_ARM
55 /* FPU emulator */
56 #include "nwfpe/fpa11.h"
57 #endif
58
59 /* NOTE: we force a big alignment so that the stack stored after is
60    aligned too */
61 typedef struct TaskState {
62     struct TaskState *next;
63 #ifdef TARGET_ARM
64     /* FPA state */
65     FPA11 fpa;
66     int swi_errno;
67 #endif
68 #if defined(TARGET_I386) && !defined(TARGET_X86_64)
69     target_ulong target_v86;
70     struct vm86_saved_state vm86_saved_regs;
71     struct target_vm86plus_struct vm86plus;
72     uint32_t v86flags;
73     uint32_t v86mask;
74 #endif
75 #ifdef TARGET_M68K
76     int sim_syscalls;
77 #endif
78 #if defined(TARGET_ARM) || defined(TARGET_M68K)
79     /* Extra fields for semihosted binaries.  */
80     uint32_t stack_base;
81     uint32_t heap_base;
82     uint32_t heap_limit;
83 #endif
84     int used; /* non zero if used */
85     struct image_info *info;
86     uint8_t stack[0];
87 } __attribute__((aligned(16))) TaskState;
88
89 extern TaskState *first_task_state;
90 extern const char *qemu_uname_release;
91
92 /* ??? See if we can avoid exposing so much of the loader internals.  */
93 /*
94  * MAX_ARG_PAGES defines the number of pages allocated for arguments
95  * and envelope for the new program. 32 should suffice, this gives
96  * a maximum env+arg of 128kB w/4KB pages!
97  */
98 #define MAX_ARG_PAGES 32
99
100 /*
101  * This structure is used to hold the arguments that are
102  * used when loading binaries.
103  */
104 struct linux_binprm {
105         char buf[128];
106         void *page[MAX_ARG_PAGES];
107         unsigned long p;
108         int fd;
109         int e_uid, e_gid;
110         int argc, envc;
111         char **argv;
112         char **envp;
113         char * filename;        /* Name of binary */
114 };
115
116 void do_init_thread(struct target_pt_regs *regs, struct image_info *infop);
117 target_ulong loader_build_argptr(int envc, int argc, target_ulong sp,
118                                  target_ulong stringp, int push_ptr);
119 int loader_exec(const char * filename, char ** argv, char ** envp,
120              struct target_pt_regs * regs, struct image_info *infop);
121
122 int load_elf_binary(struct linux_binprm * bprm, struct target_pt_regs * regs,
123                     struct image_info * info);
124 int load_flt_binary(struct linux_binprm * bprm, struct target_pt_regs * regs,
125                     struct image_info * info);
126
127 void memcpy_to_target(target_ulong dest, const void *src,
128                       unsigned long len);
129 void target_set_brk(target_ulong new_brk);
130 target_long do_brk(target_ulong new_brk);
131 void syscall_init(void);
132 target_long do_syscall(void *cpu_env, int num, target_long arg1,
133                        target_long arg2, target_long arg3, target_long arg4,
134                        target_long arg5, target_long arg6);
135 void gemu_log(const char *fmt, ...) __attribute__((format(printf,1,2)));
136 extern CPUState *global_env;
137 void cpu_loop(CPUState *env);
138 void init_paths(const char *prefix);
139 const char *path(const char *pathname);
140
141 extern int loglevel;
142 extern FILE *logfile;
143
144 /* signal.c */
145 void process_pending_signals(void *cpu_env);
146 void signal_init(void);
147 int queue_signal(int sig, target_siginfo_t *info);
148 void host_to_target_siginfo(target_siginfo_t *tinfo, const siginfo_t *info);
149 void target_to_host_siginfo(siginfo_t *info, const target_siginfo_t *tinfo);
150 long do_sigreturn(CPUState *env);
151 long do_rt_sigreturn(CPUState *env);
152
153 #ifdef TARGET_I386
154 /* vm86.c */
155 void save_v86_state(CPUX86State *env);
156 void handle_vm86_trap(CPUX86State *env, int trapno);
157 void handle_vm86_fault(CPUX86State *env);
158 int do_vm86(CPUX86State *env, long subfunction, target_ulong v86_addr);
159 #endif
160
161 /* mmap.c */
162 int target_mprotect(target_ulong start, target_ulong len, int prot);
163 long target_mmap(target_ulong start, target_ulong len, int prot,
164                  int flags, int fd, target_ulong offset);
165 int target_munmap(target_ulong start, target_ulong len);
166 long target_mremap(target_ulong old_addr, target_ulong old_size,
167                    target_ulong new_size, unsigned long flags,
168                    target_ulong new_addr);
169 int target_msync(target_ulong start, target_ulong len, int flags);
170
171 /* user access */
172
173 #define VERIFY_READ 0
174 #define VERIFY_WRITE 1
175
176 #define access_ok(type,addr,size) (1)
177
178 /* NOTE get_user and put_user use host addresses.  */
179 #define __put_user(x,ptr)\
180 ({\
181     int size = sizeof(*ptr);\
182     switch(size) {\
183     case 1:\
184         *(uint8_t *)(ptr) = (typeof(*ptr))(x);\
185         break;\
186     case 2:\
187         *(uint16_t *)(ptr) = tswap16((typeof(*ptr))(x));\
188         break;\
189     case 4:\
190         *(uint32_t *)(ptr) = tswap32((typeof(*ptr))(x));\
191         break;\
192     case 8:\
193         *(uint64_t *)(ptr) = tswap64((typeof(*ptr))(x));\
194         break;\
195     default:\
196         abort();\
197     }\
198     0;\
199 })
200
201 #define __get_user(x, ptr) \
202 ({\
203     int size = sizeof(*ptr);\
204     switch(size) {\
205     case 1:\
206         x = (typeof(*ptr))*(uint8_t *)(ptr);\
207         break;\
208     case 2:\
209         x = (typeof(*ptr))tswap16(*(uint16_t *)(ptr));\
210         break;\
211     case 4:\
212         x = (typeof(*ptr))tswap32(*(uint32_t *)(ptr));\
213         break;\
214     case 8:\
215         x = (typeof(*ptr))tswap64(*(uint64_t *)(ptr));\
216         break;\
217     default:\
218         abort();\
219     }\
220     0;\
221 })
222
223 #define put_user(x,ptr)\
224 ({\
225     int __ret;\
226     if (access_ok(VERIFY_WRITE, ptr, sizeof(*ptr)))\
227         __ret = __put_user(x, ptr);\
228     else\
229         __ret = -EFAULT;\
230     __ret;\
231 })
232
233 #define get_user(x,ptr)\
234 ({\
235     int __ret;\
236     if (access_ok(VERIFY_READ, ptr, sizeof(*ptr)))\
237         __ret = __get_user(x, ptr);\
238     else\
239         __ret = -EFAULT;\
240     __ret;\
241 })
242
243 /* Functions for accessing guest memory.  The tget and tput functions
244    read/write single values, byteswapping as neccessary.  The lock_user
245    gets a pointer to a contiguous area of guest memory, but does not perform
246    and byteswapping.  lock_user may return either a pointer to the guest
247    memory, or a temporary buffer.  */
248
249 /* Lock an area of guest memory into the host.  If copy is true then the
250    host area will have the same contents as the guest.  */
251 static inline void *lock_user(target_ulong guest_addr, long len, int copy)
252 {
253 #ifdef DEBUG_REMAP
254     void *addr;
255     addr = malloc(len);
256     if (copy)
257         memcpy(addr, g2h(guest_addr), len);
258     else
259         memset(addr, 0, len);
260     return addr;
261 #else
262     return g2h(guest_addr);
263 #endif
264 }
265
266 /* Unlock an area of guest memory.  The first LEN bytes must be flushed back
267    to guest memory.  */
268 static inline void unlock_user(void *host_addr, target_ulong guest_addr,
269                                 long len)
270 {
271 #ifdef DEBUG_REMAP
272     if (host_addr == g2h(guest_addr))
273         return;
274     if (len > 0)
275         memcpy(g2h(guest_addr), host_addr, len);
276     free(host_addr);
277 #endif
278 }
279
280 /* Return the length of a string in target memory.  */
281 static inline int target_strlen(target_ulong ptr)
282 {
283   return strlen(g2h(ptr));
284 }
285
286 /* Like lock_user but for null terminated strings.  */
287 static inline void *lock_user_string(target_ulong guest_addr)
288 {
289     long len;
290     len = target_strlen(guest_addr) + 1;
291     return lock_user(guest_addr, len, 1);
292 }
293
294 /* Helper macros for locking/ulocking a target struct.  */
295 #define lock_user_struct(host_ptr, guest_addr, copy) \
296     host_ptr = lock_user(guest_addr, sizeof(*host_ptr), copy)
297 #define unlock_user_struct(host_ptr, guest_addr, copy) \
298     unlock_user(host_ptr, guest_addr, (copy) ? sizeof(*host_ptr) : 0)
299
300 #define tget8(addr) ldub(addr)
301 #define tput8(addr, val) stb(addr, val)
302 #define tget16(addr) lduw(addr)
303 #define tput16(addr, val) stw(addr, val)
304 #define tget32(addr) ldl(addr)
305 #define tput32(addr, val) stl(addr, val)
306 #define tget64(addr) ldq(addr)
307 #define tput64(addr, val) stq(addr, val)
308 #if TARGET_LONG_BITS == 64
309 #define tgetl(addr) ldq(addr)
310 #define tputl(addr, val) stq(addr, val)
311 #else
312 #define tgetl(addr) ldl(addr)
313 #define tputl(addr, val) stl(addr, val)
314 #endif
315
316 #endif /* QEMU_H */