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