Add doc, html, dvi and .PHONY Makefile targets.
[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   end_data;
22         unsigned long   start_brk;
23         unsigned long   brk;
24         unsigned long   start_mmap;
25         unsigned long   mmap;
26         unsigned long   rss;
27         unsigned long   start_stack;
28         unsigned long   arg_start;
29         unsigned long   arg_end;
30         unsigned long   env_start;
31         unsigned long   env_end;
32         unsigned long   entry;
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     /* Extra fields for semihosted binaries.  */
66     uint32_t stack_base;
67     uint32_t heap_base;
68     uint32_t heap_limit;
69     int swi_errno;
70 #endif
71 #ifdef TARGET_I386
72     target_ulong target_v86;
73     struct vm86_saved_state vm86_saved_regs;
74     struct target_vm86plus_struct vm86plus;
75     uint32_t v86flags;
76     uint32_t v86mask;
77 #endif
78     int used; /* non zero if used */
79     uint8_t stack[0];
80 } __attribute__((aligned(16))) TaskState;
81
82 extern TaskState *first_task_state;
83 extern const char *qemu_uname_release;
84
85 int elf_exec(const char * filename, char ** argv, char ** envp, 
86              struct target_pt_regs * regs, struct image_info *infop);
87
88 void target_set_brk(target_ulong new_brk);
89 long do_brk(target_ulong new_brk);
90 void syscall_init(void);
91 long do_syscall(void *cpu_env, int num, long arg1, long arg2, long arg3, 
92                 long arg4, long arg5, long arg6);
93 void gemu_log(const char *fmt, ...) __attribute__((format(printf,1,2)));
94 extern CPUState *global_env;
95 void cpu_loop(CPUState *env);
96 void init_paths(const char *prefix);
97 const char *path(const char *pathname);
98
99 extern int loglevel;
100 extern FILE *logfile;
101
102 /* signal.c */
103 void process_pending_signals(void *cpu_env);
104 void signal_init(void);
105 int queue_signal(int sig, target_siginfo_t *info);
106 void host_to_target_siginfo(target_siginfo_t *tinfo, const siginfo_t *info);
107 void target_to_host_siginfo(siginfo_t *info, const target_siginfo_t *tinfo);
108 long do_sigreturn(CPUState *env);
109 long do_rt_sigreturn(CPUState *env);
110
111 #ifdef TARGET_I386
112 /* vm86.c */
113 void save_v86_state(CPUX86State *env);
114 void handle_vm86_trap(CPUX86State *env, int trapno);
115 void handle_vm86_fault(CPUX86State *env);
116 int do_vm86(CPUX86State *env, long subfunction, target_ulong v86_addr);
117 #endif
118
119 /* mmap.c */
120 int target_mprotect(target_ulong start, target_ulong len, int prot);
121 long target_mmap(target_ulong start, target_ulong len, int prot, 
122                  int flags, int fd, target_ulong offset);
123 int target_munmap(target_ulong start, target_ulong len);
124 long target_mremap(target_ulong old_addr, target_ulong old_size, 
125                    target_ulong new_size, unsigned long flags,
126                    target_ulong new_addr);
127 int target_msync(target_ulong start, target_ulong len, int flags);
128
129 /* user access */
130
131 #define VERIFY_READ 0
132 #define VERIFY_WRITE 1
133
134 #define access_ok(type,addr,size) (1)
135
136 /* NOTE get_user and put_user use host addresses.  */
137 #define __put_user(x,ptr)\
138 ({\
139     int size = sizeof(*ptr);\
140     switch(size) {\
141     case 1:\
142         *(uint8_t *)(ptr) = (typeof(*ptr))(x);\
143         break;\
144     case 2:\
145         *(uint16_t *)(ptr) = tswap16((typeof(*ptr))(x));\
146         break;\
147     case 4:\
148         *(uint32_t *)(ptr) = tswap32((typeof(*ptr))(x));\
149         break;\
150     case 8:\
151         *(uint64_t *)(ptr) = tswap64((typeof(*ptr))(x));\
152         break;\
153     default:\
154         abort();\
155     }\
156     0;\
157 })
158
159 #define __get_user(x, ptr) \
160 ({\
161     int size = sizeof(*ptr);\
162     switch(size) {\
163     case 1:\
164         x = (typeof(*ptr))*(uint8_t *)(ptr);\
165         break;\
166     case 2:\
167         x = (typeof(*ptr))tswap16(*(uint16_t *)(ptr));\
168         break;\
169     case 4:\
170         x = (typeof(*ptr))tswap32(*(uint32_t *)(ptr));\
171         break;\
172     case 8:\
173         x = (typeof(*ptr))tswap64(*(uint64_t *)(ptr));\
174         break;\
175     default:\
176         abort();\
177     }\
178     0;\
179 })
180
181 #define put_user(x,ptr)\
182 ({\
183     int __ret;\
184     if (access_ok(VERIFY_WRITE, ptr, sizeof(*ptr)))\
185         __ret = __put_user(x, ptr);\
186     else\
187         __ret = -EFAULT;\
188     __ret;\
189 })
190
191 #define get_user(x,ptr)\
192 ({\
193     int __ret;\
194     if (access_ok(VERIFY_READ, ptr, sizeof(*ptr)))\
195         __ret = __get_user(x, ptr);\
196     else\
197         __ret = -EFAULT;\
198     __ret;\
199 })
200
201 /* Functions for accessing guest memory.  The tget and tput functions
202    read/write single values, byteswapping as neccessary.  The lock_user
203    gets a pointer to a contiguous area of guest memory, but does not perform
204    and byteswapping.  lock_user may return either a pointer to the guest
205    memory, or a temporary buffer.  */
206
207 /* Lock an area of guest memory into the host.  If copy is true then the
208    host area will have the same contents as the guest.  */
209 static inline void *lock_user(target_ulong guest_addr, long len, int copy)
210 {
211 #ifdef DEBUG_REMAP
212     void *addr;
213     addr = malloc(len);
214     if (copy)
215         memcpy(addr, g2h(guest_addr), len);
216     else
217         memset(addr, 0, len);
218     return addr;
219 #else
220     return g2h(guest_addr);
221 #endif
222 }
223
224 /* Unlock an area of guest memory.  The first LEN bytes must be flushed back
225    to guest memory.  */
226 static inline void unlock_user(void *host_addr, target_ulong guest_addr,
227                                 long len)
228 {
229 #ifdef DEBUG_REMAP
230     if (host_addr == g2h(guest_addr))
231         return;
232     if (len > 0)
233         memcpy(g2h(guest_addr), host_addr, len);
234     free(host_addr);
235 #endif
236 }
237
238 /* Return the length of a string in target memory.  */
239 static inline int target_strlen(target_ulong ptr)
240 {
241   return strlen(g2h(ptr));
242 }
243
244 /* Like lock_user but for null terminated strings.  */
245 static inline void *lock_user_string(target_ulong guest_addr)
246 {
247     long len;
248     len = target_strlen(guest_addr) + 1;
249     return lock_user(guest_addr, len, 1);
250 }
251
252 /* Helper macros for locking/ulocking a target struct.  */
253 #define lock_user_struct(host_ptr, guest_addr, copy) \
254     host_ptr = lock_user(guest_addr, sizeof(*host_ptr), copy)
255 #define unlock_user_struct(host_ptr, guest_addr, copy) \
256     unlock_user(host_ptr, guest_addr, (copy) ? sizeof(*host_ptr) : 0)
257
258 #define tget8(addr) ldub(addr)
259 #define tput8(addr, val) stb(addr, val)
260 #define tget16(addr) lduw(addr)
261 #define tput16(addr, val) stw(addr, val)
262 #define tget32(addr) ldl(addr)
263 #define tput32(addr, val) stl(addr, val)
264 #define tget64(addr) ldq(addr)
265 #define tput64(addr, val) stq(addr, val)
266 #if TARGET_LONG_BITS == 64
267 #define tgetl(addr) ldq(addr)
268 #define tputl(addr, val) stq(addr, val)
269 #else
270 #define tgetl(addr) ldl(addr)
271 #define tputl(addr, val) stl(addr, val)
272 #endif
273
274 #endif /* QEMU_H */