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